From: "SZEDER Gábor" <szeder.dev@gmail.com>
To: Stefan Beller <sbeller@google.com>
Cc: "SZEDER Gábor" <szeder.dev@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] config: document blame configuration
Date: Thu, 2 Nov 2017 01:07:22 +0100 [thread overview]
Message-ID: <20171102000722.1503-1-szeder.dev@gmail.com> (raw)
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.
> 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 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.
> +
> 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
>
>
next prev parent reply other threads:[~2017-11-02 0:07 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-01 22:32 [PATCH] config: document blame configuration Stefan Beller
2017-11-02 0:07 ` SZEDER Gábor [this message]
2017-11-02 18:10 ` [PATCHv2] " Stefan Beller
2017-11-03 1:26 ` SZEDER Gábor
2017-11-03 2:27 ` Stefan Beller
2017-11-03 19:21 ` [PATCH] " Stefan Beller
2017-11-06 1:14 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171102000722.1503-1-szeder.dev@gmail.com \
--to=szeder.dev@gmail.com \
--cc=git@vger.kernel.org \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).