diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-09-18 10:07:00 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-09-18 10:07:00 -0700 |
| commit | 1fbfabfa71fc596383d221c7760e91c39f68c076 (patch) | |
| tree | 0deda3fa32ca0b905a0dbf1558ab98d044d21e3f /Documentation/config | |
| parent | f0d71c3ed05e1b835a5b49198047b4c7aa760fa4 (diff) | |
| parent | ace1bb71503bc53b42ddfd68435c3af0adaf390f (diff) | |
| download | git-1fbfabfa71fc596383d221c7760e91c39f68c076.tar.xz | |
Merge branch 'pw/3.0-commentchar-auto-deprecation'
"core.commentChar=auto" that attempts to dynamically pick a
suitable comment character is non-workable, as it is too much
trouble to support for little benefit, and is marked as deprecated.
* pw/3.0-commentchar-auto-deprecation:
commit: print advice when core.commentString=auto
config: warn on core.commentString=auto
breaking-changes: deprecate support for core.commentString=auto
Diffstat (limited to 'Documentation/config')
| -rw-r--r-- | Documentation/config/core.adoc | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/Documentation/config/core.adoc b/Documentation/config/core.adoc index 3fbe83eef1..08739bb9d4 100644 --- a/Documentation/config/core.adoc +++ b/Documentation/config/core.adoc @@ -531,9 +531,25 @@ core.commentString:: commented, and removes them after the editor returns (default '#'). + -If set to "auto", `git-commit` would select a character that is not +ifndef::with-breaking-changes[] +If set to "auto", `git-commit` will select a character that is not the beginning character of any line in existing commit messages. +Support for this value is deprecated and will be removed in Git 3.0 +due to the following limitations: + +-- +* It is incompatible with adding comments in a commit message + template. This includes the conflicts comments added to + the commit message by `cherry-pick`, `merge`, `rebase` and + `revert`. +* It is incompatible with adding comments to the commit message + in the `prepare-commit-msg` hook. +* It is incompatible with the `fixup` and `squash` commands when + rebasing, +* It is not respected by `git notes` +-- ++ +endif::with-breaking-changes[] 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 `commentChar`. Versions of Git prior to v2.45.0 will ignore |