config: document blame configuration
PATCH 1/1 config: document blame configuration
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.
--- Documentation/config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
Documentation/config.txt +17 -0
@@ -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:: + Do not treat root commits as boundaries in `git-blame`. + This option defaults to false. + +blame.blankboundary:: + Show blank SHA-1 for boundary commits in `git-blame`. + This option defaults to false. + +blame.showemail:: + 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]. + branch.autoSetupMerge:: Tells 'git branch' and 'git checkout' to set up new branches so that linkgit:git-pull[1] will appropriately merge from the
Signature · 1 line
2.15.0.7.g980e40477f
Quoted 3 lines
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.
Quoted 10 lines
Signed-off-by Stefan Beller <[email protected]>--- Documentation/config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)Documentation/config.txt +0
-0
Documentation/config.txt apply.whitespace:: · line 952
Quoted 4 lines
Documentation/config.txt +1
-0@@ -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?
Documentation/config.txt apply.whitespace:: · line 953
Quoted 1 line
Documentation/config.txt +1
-0+ 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.
Documentation/config.txt apply.whitespace:: · line 956
Quoted 3 lines
Documentation/config.txt +3
-0+ 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.
Documentation/config.txt apply.whitespace:: · line 957
Quoted 1 line
Documentation/config.txt +1
-0+ Show blank SHA-1 for boundary commits in `git-blame`.
Perhaps "Show blank object ID", since we're moving away from SHA-1?
Documentation/config.txt apply.whitespace:: · line 960
Quoted 3 lines
Documentation/config.txt +3
-0+ This option defaults to false. + +blame.showemail::
Again camelCase.
Documentation/config.txt apply.whitespace:: · line 967
Quoted 7 lines
Documentation/config.txt +7
-0+ 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.
Quoted 8 lines
Documentation/config.txt +1
-0+ branch.autoSetupMerge:: Tells 'git branch' and 'git checkout' to set up new branches so that linkgit:git-pull[1] will appropriately merge from theSignature · 1 line
2.15.0.7.g980e40477f
PATCH v2 1/1 config: document blame configuration
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.
---
* correct option to blame.showRoot
* camelCased other options
* use linkgit:git-<command>[1] instead of git-cmd as that is correct, but maybe overused.
* --date is backticked now.
Documentation/config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
Documentation/config.txt +17 -0
@@ -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.showRoot:: + Do not treat root commits as boundaries in linkgit:git-blame[1]. + This option defaults to false. + +blame.blankBoundary:: + Show blank SHA-1 for boundary commits in linkgit:git-blame[1]. + This option defaults to false. + +blame.showEmail:: + Show the author email instead of author name in linkgit:git-blame[1]. + This option defaults to false. + +blame.date:: + Specifies the format used to output dates in linkgit:git-blame[1]. + If unset the iso format is used. For supported values, + see the discussion of the `--date` option at linkgit:git-log[1]. + branch.autoSetupMerge:: Tells 'git branch' and 'git checkout' to set up new branches so that linkgit:git-pull[1] will appropriately merge from the
Signature · 1 line
2.15.0.7.g980e40477f
Documentation/config.txt apply.whitespace:: · line 957
Quoted 2 lines · Stefan Beller
Documentation/config.txt +2
-0+blame.blankBoundary:: + Show blank SHA-1 for boundary commits in linkgit:git-blame[1].
This is still SHA-1 instead of object id (or perhaps "commit object name" would be even better).
Not sure whether oversight or intentional.
Quoted 8 lines · SZEDER Gábor
Documentation/config.txt apply.whitespace:: · line 957
Quoted 2 lines · Stefan Beller
Documentation/config.txt +2
-0+blame.blankBoundary:: + Show blank SHA-1 for boundary commits in linkgit:git-blame[1].This is still SHA-1 instead of object id (or perhaps "commit object name" would be even better).
Not sure whether oversight or intentional.
definitely oversight.
PATCH 1/1 config: document blame configuration
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.
---
Now with 'commit object name'.
Thanks!
Documentation/config.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)
Documentation/config.txt +17 -0
@@ -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.showRoot:: + Do not treat root commits as boundaries in linkgit:git-blame[1]. + This option defaults to false. + +blame.blankBoundary:: + Show blank commit object name for boundary commits in + linkgit:git-blame[1]. This option defaults to false. + +blame.showEmail:: + Show the author email instead of author name in linkgit:git-blame[1]. + This option defaults to false. + +blame.date:: + Specifies the format used to output dates in linkgit:git-blame[1]. + If unset the iso format is used. For supported values, + see the discussion of the `--date` option at linkgit:git-log[1]. + branch.autoSetupMerge:: Tells 'git branch' and 'git checkout' to set up new branches so that linkgit:git-pull[1] will appropriately merge from the
Signature · 1 line
2.15.0.7.g980e40477f
Quoted 6 lines · Stefan Beller
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.
Signed-off-by Stefan Beller <[email protected]>---
Excellent. Will queue. Thanks.