diff options
| author | Maxim Cournoyer <maxim@guixotic.coop> | 2025-08-01 14:46:58 +0900 |
|---|---|---|
| committer | Maxim Cournoyer <maxim@guixotic.coop> | 2026-06-12 18:19:18 +0900 |
| commit | 81a7856dd893aab74ff5562aa6d90aa7ec70c05f (patch) | |
| tree | 7765c72c7b1e115d9e2d404bc4fcf54d4bea793c /doc | |
| parent | e6566646240708a8e65e69a9ba6570f67bb7e986 (diff) | |
Revert "build: Add a commit-msg hook that embeds Change-Id in commit messages."
This reverts commit 8005e09b261d65bf0f7469cd8e89423c1c1db820 and follow-ups.
This was added 2 years ago to be able to trace commits between the git
repository and the guix-patches tracker, and to implement a solution to
automatically close merged commits (which has not materialized).
Since we have now migrated to Codeberg, the cross-referencing between reviewed
commits (pull requests) and the actual commits merged can be done in the
Codeberg UI (via the 'manually merged' option), and Codeberg also supports
closing a bug via the "Fixes: #NNN" git trailer, and as a convention we can
add a "Merges: !NNN" git trailer in a commit closing a PR (the actual closing
is not yet implemented by Forgejo), which mostly obsoletes the purpose of the
Change-Id git trailer.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.texi | 10 |
1 files changed, 1 insertions, 9 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index 0da29d4c68b..0863bf5c2f4 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi | |||
| @@ -2250,16 +2250,8 @@ different name or email just for commits in this repository, you can | |||
| 2250 | use @command{git config --local}, or edit @file{.git/config} in the | 2250 | use @command{git config --local}, or edit @file{.git/config} in the |
| 2251 | repository instead of @file{~/.gitconfig}. | 2251 | repository instead of @file{~/.gitconfig}. |
| 2252 | 2252 | ||
| 2253 | @cindex commit-msg hook | ||
| 2254 | Other important Git configuration will automatically be configured when | 2253 | Other important Git configuration will automatically be configured when |
| 2255 | building the project (@pxref{Building from Git}). A | 2254 | building the project (@pxref{Building from Git}). |
| 2256 | @file{.git/hooks/commit-msg} hook will be installed that embeds | ||
| 2257 | @samp{Change-Id} Git @emph{trailers} in your commit messages for | ||
| 2258 | traceability purposes. It is important to preserve these when editing | ||
| 2259 | your commit messages, particularly if a first version of your proposed | ||
| 2260 | changes was already submitted for review. If you have a | ||
| 2261 | @file{commit-msg} hook of your own you would like to use with Guix, you | ||
| 2262 | can place it under the @file{.git/hooks/commit-msg.d/} directory. | ||
| 2263 | 2255 | ||
| 2264 | @node Tracking Bugs and Changes | 2256 | @node Tracking Bugs and Changes |
| 2265 | @section Tracking Bugs and Changes | 2257 | @section Tracking Bugs and Changes |
