aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Muskee <wimmuskee@gmail.com>2020-01-03 09:46:31 +0100
committerGöktürk Yüksek <gokturk@gentoo.org>2020-01-14 15:35:46 -0500
commit95251a20ed3b8d7de99b355a6f02e9065bf8177a (patch)
treebd6c030e4a88e321ff38d72a80fb1ae734ba7052 /ebuild-maintenance
parentgeneral-concepts/licenses: Add 'Further reading' subsection (diff)
downloaddevmanual-95251a20ed3b8d7de99b355a6f02e9065bf8177a.tar.gz
devmanual-95251a20ed3b8d7de99b355a6f02e9065bf8177a.tar.bz2
devmanual-95251a20ed3b8d7de99b355a6f02e9065bf8177a.zip
ebuild-maintenance/git: merge different references to #BUG-ID
Closes: https://github.com/gentoo/devmanual/pull/133 Signed-off-by: Wim Muskee <wimmuskee@gmail.com> Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
Diffstat (limited to 'ebuild-maintenance')
-rw-r--r--ebuild-maintenance/git/text.xml12
1 files changed, 3 insertions, 9 deletions
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 864036e..d58b35f 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -233,16 +233,16 @@ For packages where <c>${CATEGORY}/${PN}:</c> is long, the line length
limit can be exceeded, if absolutely necessary, to ensure a more
useful summary line. If a commit affects multiple directories, prepend
the message with which reflects the intention of the change best. If
-there are any bugs on Gentoo Bugzilla associated with the commit, id
+there are any bugs on Gentoo Bugzilla associated with the commit, the id
of the bug can be appended to the summary line using the format
-<c>#BUG-ID</c>. If you are modifying keywords, clearly state what
+<c>#nnnnnn</c>. If you are modifying keywords, clearly state what
keywords are added/removed.
</p>
<warning>
By default, lines starting with <c>#</c> are considered to be comments
by git and not included in the commit message. Make sure that a new
-line does not start with <c>#BUG-ID</c>. Optionally, git can be
+line does not start with <c>#nnnnnn</c>. Optionally, git can be
configured to use a different character for comments by changing the
<c>commentchar</c> option.
</warning>
@@ -286,12 +286,6 @@ as --force) for the commit.</li>
</ul>
<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