Add troubleshooting information #1023
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koutcher
force-pushed
the
troubleshooting
branch
2 times, most recently
from
21f389f
to
2ce85fe
Compare
koutcher
force-pushed
the
troubleshooting
branch
3 times, most recently
from
9be7239
to
f11795b
Compare
jonas
approved these changes
Dec 21, 2020
|
|
||
| See ESCDELAY environment variable in ncurses(3x) to reduce the one | ||
| second delay after pressing the escape key. Nowadays, | ||
| `export ESCDELAY=100` should be more than enough. |
There was a problem hiding this comment.
LGTM, I don't know if it would make sense to link to this page from the README's bug reporting section.
Good idea. Is this appropriate ?
Bugs and Feature Requests
-------------------------
+Please check out the
+https://github.com/jonas/tig/blob/master/TROUBLESHOOTING.adoc[troubleshooting guide]
+if you are experiencing issues with Tig.
+
Bugs and feature requests can be reported using theThere was a problem hiding this comment.
Yes, or we could also add it to book.md to make it part of the documentation site and link to it "relatively" using
link:TROUBLESHOOTING.{docext}[troubleshooting guide]I can do that if you prefer in a future PR.
There was a problem hiding this comment.
I have pushed my current state to the PR, I'll be happy if you want to take the lead on it. Edit at your convenience.
krobelus
reviewed
Dec 21, 2020
TROUBLESHOOTING.adoc
Outdated
| accented characters will be distorted. | ||
|
|
||
| To check that your locale is present in the list of available locales, | ||
| use `locale -a | grep "$LANG"`. |
There was a problem hiding this comment.
I get
$ locale -a
C
en_US.utf8
POSIX
$ echo $LANG
en_US.UTF-8
and I think it works fine, so I guess
Suggested change
| use `locale -a | grep "$LANG"`. | |
| use `locale -a | grep -i "$LANG"`. |
There was a problem hiding this comment.
Thanks for reporting, looks like utf8 is a Linux oddity. -i won't help because of the missing hyphen. So I'd rather reword to:
-To check that your locale is present in the list of available locales,
-use `locale -a | grep "$LANG"`.
+Use `locale -a` to check if your `LANG` variable is present in the
+list of available locales (on Linux, you may find that `UTF-8` has
+been substituted for `utf8` but they are equivalent).There was a problem hiding this comment.
Sounds good, thanks!
systemd's localectl list-locales uses en_US.UTF-8, but of course that's not available elsewhere.
koutcher
force-pushed
the
troubleshooting
branch
3 times, most recently
from
2a52f67
to
250af2c
Compare
koutcher
force-pushed
the
troubleshooting
branch
from
250af2c
to
09c7ea3
Compare
koutcher
force-pushed
the
troubleshooting
branch
from
09c7ea3
to
925c909
Compare
krobelus
reviewed
Jan 31, 2021
TROUBLESHOOTING.adoc
Outdated
Comment on lines
69
to
70
| Note that the ability to set the `LANG` variable to values such as | ||
| `en_DE` with KDE does not infer their validity. |
There was a problem hiding this comment.
Suggested change
| Note that the ability to set the `LANG` variable to values such as | |
| `en_DE` with KDE does not infer their validity. | |
| Note that the ability to set the `LANG` variable to values such as | |
| `en_DE` with KDE does not imply their validity. |
TROUBLESHOOTING.adoc
Outdated
Comment on lines
42
to
43
| Some OS (e.g. OS X 10.11) are shipping with an incomplete terminfo | ||
| description for screen resulting, for example, in diff-highlight option |
There was a problem hiding this comment.
Suggested change
| Some OS (e.g. OS X 10.11) are shipping with an incomplete terminfo | |
| description for screen resulting, for example, in diff-highlight option | |
| Some OS (e.g. OS X 10.11) are shipping with an incomplete terminfo | |
| description for screen resulting, for example, in the diff-highlight option |
koutcher
force-pushed
the
troubleshooting
branch
4 times, most recently
from
e323d59
to
7d733d7
Compare
koutcher
force-pushed
the
troubleshooting
branch
from
7d733d7
to
c5283e5
Compare
koutcher
force-pushed
the
troubleshooting
branch
from
c5283e5
to
521815b
Compare
koutcher
force-pushed
the
troubleshooting
branch
3 times, most recently
from
8dcd221
to
5a4f894
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.