Re: [PATCH] config: document blame configuration
- From
SZEDER Gábor <szeder.dev@gmail.com>
- Date
- Nov 2, 2017, 00:07 UTC
- Message-ID
- <20171102000722.1503-1-szeder.dev@gmail.com>
- In-Reply-To
- <20171101223234.14527-1-sbeller@google.com>
> The options are currently only referenced by the git-blame man page, > also explain them in git-config, which is the canonical page to > contain all config options.
Good idea.
Show 14 quoted lines
> Signed-off-by: Stefan Beller <sbeller@google.com> > --- > Documentation/config.txt | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/Documentation/config.txt b/Documentation/config.txt > index 1ac0ae6adb..b18cead6aa 100644 > --- a/Documentation/config.txt > +++ b/Documentation/config.txt > @@ -949,6 +949,23 @@ apply.whitespace:: > Tells 'git apply' how to handle whitespaces, in the same way > as the `--whitespace` option. See linkgit:git-apply[1]. > > +blame.root::
This is blame.showRoot, isn't it?
> + Do not treat root commits as boundaries in `git-blame`.
You consistently write `git-blame`, i.e. with dash and between backticks. The patch context mentions five git commands: two of them are linkgit macros, but the other three are all written without dash and between single quotes. I think it should be written without dash, but I'm not sure about single quotes vs. backticks. grep tells me they are both widespread for enclosing git commands.
> + This option defaults to false. > + > +blame.blankboundary::
Config variables are usually written in camelCase in the documentation, see e.g. branch.autoSetupMerge in the patch context below.
> + Show blank SHA-1 for boundary commits in `git-blame`.
Perhaps "Show blank object ID", since we're moving away from SHA-1?
> + This option defaults to false. > + > +blame.showemail::
Again camelCase.
Show 7 quoted lines
> + Show the author email instead of author name in `git-blame`. > + This option defaults to false. > + > +blame.date:: > + Specifies the format used to output dates in `git-blame`. > + If unset the iso format is used. For supported values, > + see the discussion of the --date option at linkgit:git-log[1].
Should '--date' be enclosed in... single quotes or backticks? I don't know.
Show 8 quoted lines
> + > branch.autoSetupMerge:: > Tells 'git branch' and 'git checkout' to set up new branches > so that linkgit:git-pull[1] will appropriately merge from the > -- > 2.15.0.7.g980e40477f > >