| Message ID | 20250315140913.577404-1-oswald.buddenhagen@gmx.de (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: clarify meaning of core.commentString=auto | expand |
Oswald Buddenhagen <oswald.buddenhagen@gmx.de> writes: > -If set to "auto", `git-commit` would select a character that is not > -the beginning character of any line in existing commit messages. This is so far in the past but I suspect this was deliberately left vague so that we can add (or subtract) the set of possible letters to use. > +If set to "auto", `git-commit` will select the first character > +from the set "#;@!$%^&|:" that does not appear at the beginning > +of any line in the prepared commit message prior to editing. So I am not sure if this is an improvement. > +Note that this makes it impossible to include comments in the > +prepare-commit-msg hook's output or the commit message template. Care to rephrase? There are degrees of possibilities and "makes it impossible" is being overly broad. I suspect you are saying that it is not nice to make it the responsibility of the end-user who chooses "auto" to ensure that they adjust the default '#' comments injected from the template or hook output when - they have a line that begins with '#' in their message; - the "auto" mechanism chooses to use ';' as the comment character; - the template is written assuming '#' as the comment character and has comments. before making a commit. But "this makes it impossible" does not quite convey that to casual readers. Thanks.
On Mon, Mar 17, 2025 at 01:17:54PM -0700, Junio C Hamano wrote: > Oswald Buddenhagen <oswald.buddenhagen@gmx.de> writes: > > > -If set to "auto", `git-commit` would select a character that is not > > -the beginning character of any line in existing commit messages. > > This is so far in the past but I suspect this was deliberately left > vague so that we can add (or subtract) the set of possible letters > to use. > > > +If set to "auto", `git-commit` will select the first character > > +from the set "#;@!$%^&|:" that does not appear at the beginning > > +of any line in the prepared commit message prior to editing. > > So I am not sure if this is an improvement. I had a similar thought while reading. The vague wording of the existing text gives us freedom to change that set of characters in the code without the possibility of the documentation becoming stale. That's pretty academic, though, so I don't have a strong feeling against this portion of the patch, but I do vaguely prefer the existing wording. Thanks, Taylor
diff --git a/Documentation/config/core.adoc b/Documentation/config/core.adoc index 8f6d8e7754..b470da72ba 100644 --- a/Documentation/config/core.adoc +++ b/Documentation/config/core.adoc @@ -526,8 +526,11 @@ core.commentString:: commented, and removes them after the editor returns (default '#'). + -If set to "auto", `git-commit` would select a character that is not -the beginning character of any line in existing commit messages. +If set to "auto", `git-commit` will select the first character +from the set "#;@!$%^&|:" that does not appear at the beginning +of any line in the prepared commit message prior to editing. +Note that this makes it impossible to include comments in the +prepare-commit-msg hook's output or the commit message template. + Note that these two variables are aliases of each other, and in modern versions of Git you are free to use a string (e.g., `//` or `⁑⁕⁑`) with
I had to read the source to make sense of the feature, which is clearly not an acceptable state. Make the docu more specific and less misleading. Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de> --- Cc: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> given the rather crippling limitations of this feature, does anyone actually use it? --- Documentation/config/core.adoc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)