mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

config: rewrite core.pager documentation

Browse Source 
The text mentions core.pager and GIT_PAGER without giving the
overall picture of precedences.  Borrow a better description from
the git-var(1) documentation.

The use of the mechanism to allow system-wide, global and
per-repository configuration files is not limited to this particular
variable.  Remove it to clarify the paragraph.

Rewrite the part that explains how the environment variable LESS is
set to Git's default value, and how to selectively customize it.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2013-08-28 13:26:12 -07:00
parent f59bebb78e
commit 97d01f2a88
1 changed files with 14 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/config.txt
View File

@ -561,22 +561,20 @@ sequence.editor::
When not configured the default commit message editor is used instead. When not configured the default commit message editor is used instead.
core.pager:: core.pager::
The command that Git will use to paginate output. Can Text viewer for use by Git commands (e.g., 'less'). The value
be overridden with the `GIT_PAGER` environment is meant to be interpreted by the shell. The order of preference
variable. Note that Git sets the `LESS` environment is the `$GIT_PAGER` environment variable, then `core.pager`
variable to `FRSX` if it is unset when it runs the configuration, then `$PAGER`, and then the default chosen at
pager. One can change these settings by setting the compile time (usually 'less').
`LESS` variable to some other value. Alternately, +
these settings can be overridden on a project or When the `LESS` environment variable is unset, Git sets it to `FRSX`
global basis by setting the `core.pager` option. (if `LESS` environment variable is set, Git does not change it at
Setting `core.pager` has no effect on the `LESS` all). If you want to selectively override Git's default setting
environment variable behaviour above, so if you want for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
to override Git's default settings this way, you need be passed to the shell by Git, which will translate the final
to be explicit. For example, to disable the S option command to `LESS=FRSX less -+S`. The environment tells the command
in a backward compatible manner, set `core.pager` to set the `S` option to chop long lines but the command line
to `less -+S`. This will be passed to the shell by resets it to the default to fold long lines.
Git, which will translate the final command to
`LESS=FRSX less -+S`.
core.whitespace:: core.whitespace::
A comma separated list of common whitespace problems to A comma separated list of common whitespace problems to