diff mbox series

[2/3] completion: Add hook in Bash completion for commit message; docs

Message ID 20240630213336.2212166-3-mikko.koivunalho@iki.fi (mailing list archive)
State New
Headers show
Series Add a Hook To git commit --message Bash Completion | expand

Commit Message

Mikko Johannes Koivunalho June 30, 2024, 9:33 p.m. UTC 
Signed-off-by: Mikko Johannes Koivunalho <mikko.koivunalho@iki.fi>
---
 Documentation/config/completion.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/config/completion.txt b/Documentation/config/completion.txt
index 4d99bf33c9..5032eab5da 100644
--- a/Documentation/config/completion.txt
+++ b/Documentation/config/completion.txt
@@ -5,3 +5,14 @@  completion.commands::
 	can add more commands, separated by space, in this
 	variable. Prefixing the command with '-' will remove it from
 	the existing list.
+
+completion.commitMessageCallback::
+    This is only used by git-completion.bash for declaring an executable
+    or a shell function which will be used when user types
+    `git commit --message=` and then presses completion key (TAB).
+    The callback must return one string for commit message.
+    This can be used when all commit messages must have, for example,
+    same prefix, e.g. a work order number.
+    Instead of this configuration variable, environment variable
+    GIT_COMPLETION_COMMIT_MESSAGE_CALLBACK can be used.
+    Environment variable overrides the configuration variable.