[prev in list] [next in list] [prev in thread] [next in thread] 

List:       git
Subject:    Re: [PATCH v2 7/9] log docs: de-duplicate configuration sections
From:       Matheus Tavares <matheus.bernardino () usp ! br>
Date:       2022-07-30 18:52:59
Message-ID: CAHd-oW4yABvvvifHe9WqZgQcErzYmiyXqZr4ssHx8ozN0w6raQ () mail ! gmail ! com
[Download RAW message or body]

On Fri, Jul 29, 2022 at 5:26 AM Ævar Arnfjörð Bjarmason
<avarab@gmail.com> wrote:
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  Documentation/config/log.txt | 18 +++++++++++++-----
>  Documentation/git-log.txt    | 33 +++++----------------------------
>  2 files changed, 18 insertions(+), 33 deletions(-)
>
> diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt
> index 456eb07800c..12ede8e31b8 100644
> --- a/Documentation/config/log.txt
> +++ b/Documentation/config/log.txt
> @@ -1,12 +1,11 @@
> -log.abbrevCommit::
> -       If true, makes linkgit:git-log[1], linkgit:git-show[1], and
> -       linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
> -       override this option with `--no-abbrev-commit`.
> -

Why was this moved ....

>  log.date::
>         Set the default date-time mode for the 'log' command.
>         Setting a value for log.date is similar to using 'git log''s
>         `--date` option.  See linkgit:git-log[1] for details.
> ++
> +If the format is set to "auto:foo" and the pager is in use, format
> +"foo" will be the used for the date format. Otherwise "default" will
> +be used.
>
>  log.decorate::
>         Print out the ref names of any commits that are shown by the log
> @@ -45,6 +44,11 @@ log.showRoot::
>         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
>         normally hide the root commit will now show it. True by default.
>
> +log.abbrevCommit::
> +       If true, makes linkgit:git-log[1], linkgit:git-show[1], and
> +       linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
> +       override this option with `--no-abbrev-commit`.
> +

... down here?

>  log.showSignature::
>         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
>         linkgit:git-whatchanged[1] assume `--show-signature`.
> @@ -53,3 +57,7 @@ log.mailmap::
>         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
>         linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
>         assume `--no-use-mailmap`. True by default.
> ++
> +The behavior of `log.mailmap` is impacted by the setting of the more
> +general 'mailmap.*' configuration variables, i.e. `mailmap.file` and
> +`mailmap.blob`.

Good.

> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index ed802bb8e12..69c4e13833d 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -42,6 +42,9 @@ OPTIONS
>         shown. The option `--decorate` is short-hand for `--decorate=short`.
>         Default to configuration value of `log.decorate` if configured,
>         otherwise, `auto`.
> ++
> +This output may be colored. See `color.ui` in linkgit:git-config[1]
> +and `color.decorate` there and in the "CONFIGURATION" section below.

Hmm, is this related to this change?

> [...]
> -log.showRoot::
> -       If `false`, `git log` and related commands will not treat the
> -       initial commit as a big creation event.  Any root commits in
> -       `git log -p` output would be shown without a diff attached.
> -       The default is `true`.
> -
> -log.showSignature::
> -       If `true`, `git log` and related commands will act as if the
> -       `--show-signature` option was passed to them.

These two have a different wording on config/log.txt, but they are
arguably better presented there anyway.
[prev in list] [next in list] [prev in thread] [next in thread]