diff options
| author |   Michał Górny <mgorny@gentoo.org> | 2017-09-06 12:28:06 +0200 |
|---|---|---|
| committer |   Göktürk Yüksek <gokturk@gentoo.org> | 2017-09-25 00:32:13 -0400 |
| commit | 4328a842d38113a60a22349636bd5c5285978c1e (patch) | |
| tree | 0b352688ea32ebe8e6c32c9b4950f0e19eb2445f | |
| parent | general-concepts/dependencies: Add a warning on pure DEPEND soft blockers (diff) | |
| download | devmanual-4328a842d38113a60a22349636bd5c5285978c1e.tar.gz devmanual-4328a842d38113a60a22349636bd5c5285978c1e.tar.bz2 devmanual-4328a842d38113a60a22349636bd5c5285978c1e.zip | |
ebuild-maintenance: Correct the tags used in footer of commit messages
Replace the 'Gentoo-Bug' tag with 'Bug' and 'Closes' tags that are
used by Portage and Gentoo Infra, and are compatible with CGIT
(gitweb), GitHub, GitLab, Bitbucket... Indicate how they affect Gentoo
Bugzilla and GitHub issues/PRs.
Move the notion about referencing bugs in summary line after the tag
descriptions (since now they're alternative to two tags).
| -rw-r--r-- | ebuild-maintenance/text.xml | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml index e1bebaf..fe56f7a 100644 --- a/ebuild-maintenance/text.xml +++ b/ebuild-maintenance/text.xml @@ -161,17 +161,21 @@ testing the changes, and revelant bugs. Use RFC822/git style tags as explained in the <uri link="https://kernel.org/doc/html/latest/process/submitting-patches.html"> Linux Kernel patch guideline</uri>. Additionally, the following tags -are used in Gentoo: +are optionally used in Gentoo: <ul> -<li><c>Gentoo-Bug:</c> Use this to reference bugs in Gentoo Bugzilla -by either the bug ID or the bugzilla URI. Multiple bugs can be -referenced by inserting more tags of this type or separating bug IDs -with a comma in the same tag. The bug IDs may include an optional '#' -prefix. There is no consensus on referencing bugs in the summary line -versus referencing with a tag in the message body. The developer has -the option to choose either. -</li> +<li><c>Bug:</c> Use this to reference bugs <e>without</e> closing them. +The value is a URL to the bug. If multiple bugs need to be referenced, +each one should be listed in a separate <c>Bug</c> tag. If a bug +on Gentoo Bugzilla, or an issue or a pull request on GitHub +is referenced, a reference to the commit will be added +automatically.</li> +<li><c>Closes:</c> Use this to reference bugs and close them +automatically. Alike <c>Bug:</c>, the value is a single URL to the bug, +and multiple tags can be used to close multiple bugs. If a bug on Gentoo +Bugzilla, or an issue or a pull request on a GitHub repository +mirrored by Gentoo is referenced, it will be closed (as fixed) +automatically with reference to the commit.</li> <li><c>Package-Manager:</c> This is automatically inserted by <c>repoman commit</c> and it specifies the version of <pkg>sys-apps/portage</pkg> on the system.</li> @@ -182,6 +186,12 @@ as --force) for the commit.</li> </p> <p> +Additionally, some developers prefer referencing bugs on the summary +line using the <c>#nnnnnn</c> form. Developers are free to use either +form, or both simultaneously to combine their advantages. +</p> + +<p> When committing <uri link="::ebuild-writing/user-submitted">user contributions</uri>, make sure to credit them in your commit message with the user's full name and email address. Be aware and respectful |