Skip to content

Commit

Permalink
Merge branch 'jc/cli-doc-option-and-config' into next
Browse files Browse the repository at this point in the history
Doc update.

* jc/cli-doc-option-and-config:
  gitcli: document that command line trumps config and env
  • Loading branch information
gitster committed Jan 17, 2025
2 parents a70beab + 4ad47d2 commit 71f41b0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Documentation/gitcli.txt
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,23 @@ can use `--no-track` to override that behaviour. The same goes for `--color`
and `--no-color`.


Options trump configuration and environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When there is a configuration variable or an environment variable
that tweak the behaviour of an aspect of a Git command, and also a
command line option that tweaks the same, the command line option
overrides what the configuration and/or environment variable say.

For example, the `user.name` configuration variable is used to
specify the human-readable name used by the `git commit` command to
record the author and the committer name in a newly created commit.
The `GIT_AUTHOR_NAME` environment variable, if set, takes precedence
when deciding what author name to record. The `--author=<author>`
command line option of the `git commit` command, when given, takes
precedence over these two sources of information.


Aggregating short options
~~~~~~~~~~~~~~~~~~~~~~~~~
Commands that support the enhanced option parser allow you to aggregate short
Expand Down

0 comments on commit 71f41b0

Please sign in to comment.