What's cooking (2021/11 #01)

todo
Junio C Hamano 2021-11-01 23:01:24 -07:00
parent 9fed826e43
commit 04050d587c
1 changed files with 195 additions and 355 deletions

View File

@ -1,10 +1,10 @@
To: git@vger.kernel.org
Bcc: lwn@lwn.net
Subject: What's cooking in git.git (Oct 2021, #07; Fri, 29)
X-master-at: 7e27bd589d328b9daf154c2444d1a86ec3afedb0
X-next-at: 81b53c28077674bc88b86c3c3dcc2dc94f93888f
Subject: What's cooking in git.git (Nov 2021, #01; Mon, 1)
X-master-at: 0cddd84c9f3e9c3d793ec93034ef679335f35e49
X-next-at: 6d82a21a3b699caf378cb0f89b6b0e803fc58480

What's cooking in git.git (Oct 2021, #07; Fri, 29)
What's cooking in git.git (Nov 2021, #01; Mon, 1)
--------------------------------------------------

Here are the topics that have been cooking in my tree. Commits
@ -18,10 +18,6 @@ useful"). Do not read too much into a topic being in (or not in)
'seen'. The ones marked with '.' do not appear in any of the
integration branches, but I am still holding onto them.

Git 2.34-rc0 has been tagged. There are still a few topics that
want to be in the upcoming release in 'next', but from here on,
let's concentrate more on fixes other than shiny new features.

Copies of the source code to Git live in many repositories, and the
following is a list of the ones I push into or their mirrors. Some
repositories have only a subset of branches.
@ -53,230 +49,16 @@ Release tarballs are available at:
--------------------------------------------------
[Graduated to 'master']

* ab/fix-make-lint-docs (2021-10-27) 1 commit
(merged to 'next' on 2021-10-27 at 04f0be2a8b)
+ Documentation/Makefile: fix lint-docs mkdir dependency

Hotfix for a topic recently merged to 'master'.


* ab/make-sparse-for-real (2021-10-21) 1 commit
(merged to 'next' on 2021-10-23 at f7a8389fb3)
+ Makefile: remove redundant GIT-CFLAGS dependency from "sparse"

Fix-up for a recent topic.


* ab/plug-handle-path-exclude-leak (2021-10-21) 1 commit
(merged to 'next' on 2021-10-23 at 6be5d7bea8)
+ config.c: don't leak memory in handle_path_include()

Leakfix.


* ab/plug-random-leaks (2021-10-23) 6 commits
(merged to 'next' on 2021-10-23 at 9c04a95718)
+ reflog: free() ref given to us by dwim_log()
+ submodule--helper: fix small memory leaks
+ clone: fix a memory leak of the "git_dir" variable
+ grep: fix a "path_list" memory leak
+ grep: use object_array_clear() in cmd_grep()
+ grep: prefer "struct grep_opt" over its "void *" equivalent

Leakfix.


* ab/ref-filter-leakfix (2021-10-20) 3 commits
(merged to 'next' on 2021-10-23 at 8066971a3d)
+ branch: use ref_sorting_release()
+ ref-filter API user: add and use a ref_sorting_release()
+ tag: use a "goto cleanup" pattern, leak less memory
(this branch is used by jc/fix-ref-sorting-parse.)

"git for-each-ref" family of commands were leaking the ref_sorting
instances that hold sorting keys specified by the user; this has
been corrected.


* ab/sh-retire-rebase-preserve-merges (2021-10-21) 2 commits
(merged to 'next' on 2021-10-23 at f1fede7500)
+ git-sh-setup: remove messaging supporting --preserve-merges
+ git-sh-i18n: remove unused eval_ngettext()

Code clean-up to remove unused helpers.


* ab/test-bail (2021-10-14) 2 commits
(merged to 'next' on 2021-10-23 at 4a16ebdb74)
+ test-lib.sh: use "Bail out!" syntax on bad SANITIZE=leak use
+ test-lib.sh: de-duplicate error() teardown code

A new feature has been added to abort early in the test framework.


* ab/unbundle-progress (2021-10-27) 1 commit
(merged to 'next' on 2021-10-27 at a6ec5e5fb5)
+ git-bundle.txt: add missing words and punctuation

Doc clarification.


* bs/archive-doc-compression-level (2021-10-25) 1 commit
(merged to 'next' on 2021-10-25 at 9360d864a2)
+ archive: describe compression level option

Update "git archive" documentation and give explicit mention on the
compression level for both zip and tar.gz format.


* bs/doc-blame-color-lines (2021-10-20) 1 commit
(merged to 'next' on 2021-10-23 at 4da10a5162)
+ git config doc: fix recent ASCIIDOC formatting regression

Doc fix.


* cm/drop-xunsetenv (2021-10-29) 1 commit
(merged to 'next' on 2021-10-29 at 3004dd0e66)
+ wrapper: remove xunsetenv()

Drop a helper function that has never been used since its addition.


* jc/branch-copy-doc (2021-10-23) 1 commit
(merged to 'next' on 2021-10-27 at efc3d30457)
+ branch (doc): -m/-c copies config and reflog

"git branch -c/-m new old" was not described to copy config, which
has been corrected.


* jk/http-push-status-fix (2021-10-18) 2 commits
(merged to 'next' on 2021-10-23 at 9704ff261d)
+ transport-helper: recognize "expecting report" error from send-pack
+ send-pack: complain about "expecting report" with --helper-status

"git push" client talking to an HTTP server did not diagnose the
lack of the final status report from the other side correctly,
which has been corrected.


* jk/log-warn-on-bogus-encoding (2021-10-29) 2 commits
(merged to 'next' on 2021-10-29 at 7fa61a88f4)
+ log: document --encoding behavior on iconv() failure
+ Revert "logmsg_reencode(): warn when iconv() fails"

Squelch over-eager warning message added during this cycle.


* js/expand-runtime-prefix (2021-10-25) 1 commit
(merged to 'next' on 2021-10-25 at 7ff05e8222)
+ config.txt: fix typo

Typofix.


* ks/submodule-add-message-fix (2021-10-27) 2 commits
(merged to 'next' on 2021-10-27 at 4fc7c47990)
+ submodule: drop unused sm_name parameter from append_fetch_remotes()
(merged to 'next' on 2021-10-25 at 377e759528)
+ submodule--helper: fix incorrect newlines in an error message

Message regression fix.


* ma/doc-folder-to-directory (2021-10-25) 3 commits
(merged to 'next' on 2021-10-27 at 99200092f7)
+ gitweb.txt: change "folder" to "directory"
+ gitignore.txt: change "folder" to "directory"
+ git-multi-pack-index.txt: change "folder" to "directory"

Consistently use 'directory', not 'folder', to call the filesystem
entity that collects a group of files and, eh, directories.


* ma/doc-git-version (2021-10-25) 1 commit
(merged to 'next' on 2021-10-25 at 9f74afec0c)
+ git.txt: fix typo

Typofix.


* mt/fix-add-rm-with-sparse-index (2021-10-28) 1 commit
(merged to 'next' on 2021-10-29 at 06f21a49b1)
+ add, rm, mv: fix bug that prevents the update of non-sparse dirs

Fix-up to a topic already merged to 'master'.


* re/completion-fix-test-equality (2021-10-28) 1 commit
(merged to 'next' on 2021-10-29 at 78decd16a0)
+ completion: fix incorrect bash/zsh string equality check

Fix long-standing shell syntax error in the completion script.


* sg/sparse-index-not-that-common-a-command (2021-10-25) 1 commit
(merged to 'next' on 2021-10-27 at 020dc425a4)
+ command-list.txt: remove 'sparse-index' from main help

Drop "git sparse-index" from the list of common commands.

--------------------------------------------------
[New Topics]

* ar/fix-git-pull-no-verify (2021-10-28) 1 commit
- pull: honor --no-verify and do not call the commit-msg hook

"git pull --no-verify" did not affect the underlying "git merge".

Will merge to 'next'.


* if/redact-packfile-uri (2021-10-29) 2 commits
- http-fetch: redact url on die() message
- fetch-pack: redact packfile urls in traces

Redact the path part of packfile URI that appears in the trace output.


* ar/no-verify-doc (2021-10-29) 1 commit
- Document positive variant of commit and merge option "--no-verify"

Doc update.

Will merge to 'next'.


* ew/test-wo-fsync (2021-10-29) 1 commit
- tests: disable fsync everywhere

Allow running our tests while disabling internal fsync.


* ja/doc-cleanup (2021-10-28) 10 commits
- init doc: --shared=0xxx does not give umask but perm bits
- doc: git-init: clarify file modes in octal.
- doc: git-http-push: describe the refs as pattern pairs
- doc: uniformize <URL> placeholders' case
- doc: use three dots for indicating repetition instead of star
- doc: git-ls-files: express options as optional alternatives
- doc: use only hyphens as word separators in placeholders
- doc: express grammar placeholders between angle brackets
- doc: split placeholders as individual tokens
- doc: fix git credential synopsis

Doc update.

Will merge to 'next'.


* re/color-default-reset (2021-10-28) 3 commits
- color: allow colors to be prefixed with "reset"
- color: support "default" to restore fg/bg color
- color: add missing GIT_COLOR_* white/black constants

"default" and "reset" colors have been added to our palette.
* ab/ignore-replace-while-working-on-commit-graph (2021-10-15) 3 commits
(merged to 'next' on 2021-10-25 at 5ed4266a96)
+ commit-graph: don't consider "replace" objects with "verify"
+ commit-graph tests: fix another graph_git_two_modes() helper
+ commit-graph tests: fix error-hiding graph_git_two_modes() helper
(this branch is used by gc/use-repo-settings.)

Teach "git commit-graph" command not to allow using replace objects
at all, as we do not use the commit-graph at runtime when we see
object replacement.


* ab/test-lib (2021-10-29) 1 commit
@ -285,35 +67,79 @@ Release tarballs are available at:

Test (cosmetic) fix.


* gc/use-repo-settings (2021-10-15) 4 commits
(merged to 'next' on 2021-10-25 at 3d38c09a8d)
+ gc: perform incremental repack when implictly enabled
+ fsck: verify multi-pack-index when implictly enabled
+ fsck: verify commit graph when implicitly enabled
+ Merge branch 'ab/ignore-replace-while-working-on-commit-graph' into gc/use-repo-settings
(this branch uses ab/ignore-replace-while-working-on-commit-graph.)

It is wrong to read some settings directly from the config
subsystem, as things like feature.experimental can affect their
default values.


* hm/paint-hits-in-log-grep (2021-10-15) 4 commits
(merged to 'next' on 2021-10-25 at e3edea3fa9)
+ grep/pcre2: fix an edge case concerning ascii patterns and UTF-8 data
+ pretty: colorize pattern matches in commit messages
+ grep: refactor next_match() and match_one_pattern() for external use
+ Merge branch 'jk/grep-haystack-is-read-only' into hm/paint-hits-in-log-grep

"git log --grep=string --author=name" learns to highlight hits just
like "git grep string" does.


* jc/doc-format-patch-clarify-auto-base (2021-10-23) 1 commit
(merged to 'next' on 2021-10-27 at 32c227324a)
+ format-patch (doc): clarify --base=auto

Rephrase the description of "format-patch --base=auto".

--------------------------------------------------
[New Topics]

* ab/mark-leak-free-tests-even-more (2021-11-01) 15 commits
- leak tests: mark some fast-import tests as passing with SANITIZE=leak
- leak tests: mark some config tests as passing with SANITIZE=leak
- leak tests: mark some status tests as passing with SANITIZE=leak
- leak tests: mark some clone tests as passing with SANITIZE=leak
- leak tests: mark some add tests as passing with SANITIZE=leak
- leak tests: mark some diff tests as passing with SANITIZE=leak
- leak tests: mark some apply tests as passing with SANITIZE=leak
- leak tests: mark some notes tests as passing with SANITIZE=leak
- leak tests: mark some update-index tests as passing with SANITIZE=leak
- leak tests: mark some rev-parse tests as passing with SANITIZE=leak
- leak tests: mark some rev-list tests as passing with SANITIZE=leak
- leak tests: mark some misc tests as passing with SANITIZE=leak
- leak tests: mark most gettext tests as passing with SANITIZE=leak
- leak tests: mark "sort" test as passing SANITIZE=leak
- leak tests: mark a read-tree test as passing SANITIZE=leak
(this branch uses jx/message-fixes.)

More tests are marked as leak-free.


* rs/ssh-signing-fix (2021-11-01) 2 commits
(merged to 'next' on 2021-11-01 at f50e78f952)
+ gpg-interface: avoid buffer overrun in parse_ssh_output()
+ gpg-interface: handle missing " with " gracefully in parse_ssh_output()

Fixes to recently merged topic.

Will merge to 'master'.


* jc/fix-first-object-walk (2021-10-29) 2 commits
- docs: add headers in MyFirstObjectWalk
- docs: fix places that break compilation in MyFirstObjectWalk
* jx/message-fixes (2021-10-31) 1 commit
(merged to 'next' on 2021-11-01 at f27cf92855)
+ i18n: fix typos found during l10n for git 2.34.0
(this branch is used by ab/mark-leak-free-tests-even-more.)

Doc update.
Fixes to recently added messages.


* jc/unsetenv-returns-an-int (2021-10-29) 1 commit
- unsetenv(3) returns int, not void

The compatibility implementation for unsetenv(3) were written to
mimic ancient, non-POSIX, variant seen in an old glibc; it has been
changed to return an integer to match the more modern era.

Will merge to 'next'.


* mc/clean-smudge-with-llp64 (2021-10-29) 8 commits
- clean/smudge: allow clean filters to process extremely large files
- odb: guard against data loss checking out a huge file
- git-compat-util: introduce more size_t helpers
- odb: teach read_blob_entry to use size_t
- t1051: introduce a smudge filter test for extremely large files
- test-lib: add prerequisite for 64-bit platforms
- test-tool genzeros: generate large amounts of data more efficiently
- test-genzeros: allow more than 2G zeros in Windows
Will merge to 'master'.

--------------------------------------------------
[Stalled]
@ -361,6 +187,91 @@ Release tarballs are available at:
--------------------------------------------------
[Cooking]

* ar/fix-git-pull-no-verify (2021-10-28) 1 commit
(merged to 'next' on 2021-11-01 at 74677b0a76)
+ pull: honor --no-verify and do not call the commit-msg hook

"git pull --no-verify" did not affect the underlying "git merge".

Will merge to 'master'.


* if/redact-packfile-uri (2021-10-29) 2 commits
- http-fetch: redact url on die() message
- fetch-pack: redact packfile urls in traces

Redact the path part of packfile URI that appears in the trace output.


* ar/no-verify-doc (2021-10-29) 1 commit
(merged to 'next' on 2021-11-01 at f6809a9ddb)
+ Document positive variant of commit and merge option "--no-verify"

Doc update.

Will merge to 'master'.


* ew/test-wo-fsync (2021-10-29) 1 commit
- tests: disable fsync everywhere

Allow running our tests while disabling internal fsync.


* ja/doc-cleanup (2021-10-28) 10 commits
- init doc: --shared=0xxx does not give umask but perm bits
- doc: git-init: clarify file modes in octal.
- doc: git-http-push: describe the refs as pattern pairs
- doc: uniformize <URL> placeholders' case
- doc: use three dots for indicating repetition instead of star
- doc: git-ls-files: express options as optional alternatives
- doc: use only hyphens as word separators in placeholders
- doc: express grammar placeholders between angle brackets
- doc: split placeholders as individual tokens
- doc: fix git credential synopsis

Doc update.

Under discussion.


* re/color-default-reset (2021-10-28) 3 commits
- color: allow colors to be prefixed with "reset"
- color: support "default" to restore fg/bg color
- color: add missing GIT_COLOR_* white/black constants

"default" and "reset" colors have been added to our palette.


* jc/fix-first-object-walk (2021-10-29) 2 commits
- docs: add headers in MyFirstObjectWalk
- docs: fix places that break compilation in MyFirstObjectWalk

Doc update.


* jc/unsetenv-returns-an-int (2021-10-29) 1 commit
(merged to 'next' on 2021-11-01 at a11670a5a5)
+ unsetenv(3) returns int, not void

The compatibility implementation for unsetenv(3) were written to
mimic ancient, non-POSIX, variant seen in an old glibc; it has been
changed to return an integer to match the more modern era.

Will cook in 'next'.


* mc/clean-smudge-with-llp64 (2021-10-29) 8 commits
- clean/smudge: allow clean filters to process extremely large files
- odb: guard against data loss checking out a huge file
- git-compat-util: introduce more size_t helpers
- odb: teach read_blob_entry to use size_t
- t1051: introduce a smudge filter test for extremely large files
- test-lib: add prerequisite for 64-bit platforms
- test-tool genzeros: generate large amounts of data more efficiently
- test-genzeros: allow more than 2G zeros in Windows


* pw/diff-color-moved-fix (2021-10-27) 15 commits
- diff --color-moved: intern strings
- diff: use designated initializers for emitted_diff_symbol
@ -436,22 +347,23 @@ Release tarballs are available at:


* tb/plug-pack-bitmap-leaks (2021-10-28) 9 commits
- pack-bitmap.c: more aggressively free in free_bitmap_index()
- pack-bitmap.c: don't leak type-level bitmaps
- midx.c: write MIDX filenames to strbuf
- builtin/multi-pack-index.c: don't leak concatenated options
- builtin/repack.c: avoid leaking child arguments
- builtin/pack-objects.c: don't leak memory via arguments
- t/helper/test-read-midx.c: free MIDX within read_midx_file()
- midx.c: don't leak MIDX from verify_midx_file
- midx.c: clean up chunkfile after reading the MIDX
(merged to 'next' on 2021-11-01 at 47d218862b)
+ pack-bitmap.c: more aggressively free in free_bitmap_index()
+ pack-bitmap.c: don't leak type-level bitmaps
+ midx.c: write MIDX filenames to strbuf
+ builtin/multi-pack-index.c: don't leak concatenated options
+ builtin/repack.c: avoid leaking child arguments
+ builtin/pack-objects.c: don't leak memory via arguments
+ t/helper/test-read-midx.c: free MIDX within read_midx_file()
+ midx.c: don't leak MIDX from verify_midx_file
+ midx.c: clean up chunkfile after reading the MIDX

Leakfix.

Will merge to 'next'?
Will cook in 'next'.


* es/pretty-describe-more (2021-10-29) 3 commits
* es/pretty-describe-more (2021-11-01) 3 commits
- pretty: add abbrev option to %(describe)
- pretty: add tag option to %(describe)
- pretty.c: rework describe options parsing for better extensibility
@ -475,15 +387,6 @@ Release tarballs are available at:
attention to the key validity time range when verifying.


* jc/doc-format-patch-clarify-auto-base (2021-10-23) 1 commit
(merged to 'next' on 2021-10-27 at 32c227324a)
+ format-patch (doc): clarify --base=auto

Rephrase the description of "format-patch --base=auto".

Will merge to 'master'.


* jc/doc-submitting-patches-choice-of-base (2021-10-25) 2 commits
- (wip) reword the final review part
- SubmittingPatchs: clarify choice of base and testing
@ -493,11 +396,12 @@ Release tarballs are available at:


* rd/http-backend-code-simplification (2021-10-25) 1 commit
- http-backend: remove a duplicated code branch
(merged to 'next' on 2021-11-01 at f45b33890c)
+ http-backend: remove a duplicated code branch

(slight) Code simplification.
Code simplification.

Will merge to 'next'?
Will merge to 'master'.


* gc/remote-with-fewer-static-global-variables (2021-10-28) 6 commits
@ -524,7 +428,7 @@ Release tarballs are available at:
Will cook in 'next'.


* ab/config-based-hooks-2 (2021-10-20) 14 commits
* ab/config-based-hooks-2 (2021-11-01) 18 commits
- run-command: remove old run_hook_{le,ve}() hook API
- receive-pack: convert push-to-checkout hook to hook.h
- read-cache: convert post-index-change to use hook.h
@ -532,31 +436,21 @@ Release tarballs are available at:
- git-p4: use 'git hook' to run hooks
- send-email: use 'git hook run' for 'sendemail-validate'
- git hook run: add an --ignore-missing flag
- hooks: convert worktree 'post-checkout' hook to hook library
- hooks: convert non-worktree 'post-checkout' hook to hook library
- merge: convert post-merge to use hook.h
- hooks: convert 'post-checkout' hook to hook library
- am: convert applypatch to use hook.h
- am: convert applypatch-msg to use hook.h
- rebase: convert pre-rebase to use hook.h
- hook API: add a run_hooks_l() wrapper
- am: convert {pre,post}-applypatch to use hook.h
- gc: use hook library for pre-auto-gc hook
- hook API: add a run_hooks() wrapper
- hook: add 'run' subcommand
- Merge branch 'ab/config-based-hooks-1' into ab/config-based-hooks-2

More "config-based hooks".


* ab/ignore-replace-while-working-on-commit-graph (2021-10-15) 3 commits
(merged to 'next' on 2021-10-25 at 5ed4266a96)
+ commit-graph: don't consider "replace" objects with "verify"
+ commit-graph tests: fix another graph_git_two_modes() helper
+ commit-graph tests: fix error-hiding graph_git_two_modes() helper
(this branch is used by gc/use-repo-settings.)

Teach "git commit-graph" command not to allow using replace objects
at all, as we do not use the commit-graph at runtime when we see
object replacement.

Will merge to 'master'.


* so/stash-staged (2021-10-28) 2 commits
(merged to 'next' on 2021-10-29 at 50335e8eeb)
+ stash: get rid of unused argument in stash_staged()
@ -716,21 +610,6 @@ Release tarballs are available at:
Ready?


* gc/use-repo-settings (2021-10-15) 4 commits
(merged to 'next' on 2021-10-25 at 3d38c09a8d)
+ gc: perform incremental repack when implictly enabled
+ fsck: verify multi-pack-index when implictly enabled
+ fsck: verify commit graph when implicitly enabled
+ Merge branch 'ab/ignore-replace-while-working-on-commit-graph' into gc/use-repo-settings
(this branch uses ab/ignore-replace-while-working-on-commit-graph.)

It is wrong to read some settings directly from the config
subsystem, as things like feature.experimental can affect their
default values.

Will merge to 'master'.


* pw/fix-some-issues-in-reset-head (2021-10-01) 12 commits
- rebase -m: don't fork git checkout
- rebase --apply: set ORIG_HEAD correctly
@ -767,26 +646,14 @@ Release tarballs are available at:


* tp/send-email-completion (2021-10-28) 2 commits
- send-email docs: add format-patch options
- send-email: programmatically generate bash completions
(merged to 'next' on 2021-11-01 at 7104356cc0)
+ send-email docs: add format-patch options
+ send-email: programmatically generate bash completions

The command line complation for "git send-email" options have been
tweaked to make it easier to keep it in sync with the command itself.

Will merge to 'next'?


* hm/paint-hits-in-log-grep (2021-10-15) 4 commits
(merged to 'next' on 2021-10-25 at e3edea3fa9)
+ grep/pcre2: fix an edge case concerning ascii patterns and UTF-8 data
+ pretty: colorize pattern matches in commit messages
+ grep: refactor next_match() and match_one_pattern() for external use
+ Merge branch 'jk/grep-haystack-is-read-only' into hm/paint-hits-in-log-grep

"git log --grep=string --author=name" learns to highlight hits just
like "git grep string" does.

Will merge to 'master'.
Will cook in 'next'.


* ns/batched-fsync (2021-10-27) 9 commits
@ -877,7 +744,7 @@ Release tarballs are available at:
Will cook in 'next'.


* ab/only-single-progress-at-once (2021-10-27) 8 commits
* ab/only-single-progress-at-once (2021-11-01) 8 commits
- progress.c: add & assert a "global_progress" variable
- various *.c: use isatty(1|2), not isatty(STDIN_FILENO|STDERR_FILENO)
- pack-bitmap-write.c: don't return without stop_progress()
@ -917,30 +784,3 @@ Release tarballs are available at:

The "reftable" backend for the refs API, without integrating into
the refs subsystem.

--------------------------------------------------
[Discarded]

* en/remerge-diff (2021-08-31) 7 commits
. doc/diff-options: explain the new --remerge-diff option
. show, log: provide a --remerge-diff capability
. tmp-objdir: new API for creating and removing primary object dirs
. merge-ort: capture and print ll-merge warnings in our preferred fashion
. ll-merge: add API for capturing warnings in a strbuf instead of stderr
. merge-ort: add ability to record conflict messages in a file
. merge-ort: mark a few more conflict messages as omittable

A new presentation for two-parent merge "--remerge-diff" can be
used to show the difference between mechanical (and possibly
conflicted) merge results and the recorded resolution.


* rb/doc-commit-header-continuation-line (2021-10-11) 1 commit
. signature-format.txt: add space to fix gpgsig continuation line

Values in the header portion of commit object can be multi-lined
by a single SP indentation of the second and subsequent lines, and
this applies to an empty line as well. Update an example in the
technical documentation to highlight it.

Superseded by the jc/doc-commit-header-continuation-line topic.