* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2015-05-09 15:22 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2015-05-09 15:22 UTC (permalink / raw
To: gentoo-commits
commit: 960ae7a0f9ef60d3afb7e47ed27e4707ed284756
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun May 3 18:07:39 2015 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed May 6 22:06:49 2015 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=960ae7a0
Merge ebuild etiquette policy from Developer Handbook.
This is taken from proj/en/devrel/handbook/hb-policy-etiquette.xml,
section "Tips", subsection "Ebuilds".
Permission to reuse the CC-BY-SA-1.0 work under CC-BY-SA-2.0
(or any later version) obtained from author plasmaroo per e-mail
on 2015-04-16.
ebuild-maintenance/text.xml | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 7325b66..ac68dcd 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -180,6 +180,15 @@ which is often more convenient.
<body>
<p>Usually you don't just change other developers ebuilds without permission unless you know that developer does not mind or if you are part of the herd involved in maintenance (this information can typically be found in metadata.xml). Start with filing a bug or trying to catch them on IRC or via email. Sometimes you cannot reach them, or there is no response to your bug. It's a good idea to consult other developers on how to handle the situation, especially if it's a critical issue that needs to be handled ASAP. Otherwise a soft limit of 2 to 4 weeks depending on the severity of the bug is an acceptable time frame before you go ahead and fix it yourself.</p>
<important> Common sense dictates to us that toolchain/base-system/core packages and eclasses or anything else which is delicate (e.g. glibc) or widely used (e.g. gtk+) should usually be left to those maintainers. If in doubt, don't touch it.</important>
+
+<p>
+Respect developers' coding preferences. Unnecessarily changing the
+syntax of an ebuild can cause complications for others. Syntax changes
+should only be done if there is a real benefit, such as faster
+compilation, improved information for the end user, or compliance with
+Gentoo policies.
+</p>
+
</body>
</section>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 63b9e0d68438e359e03846af22bf5da7902ce113
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:41 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=63b9e0d6
ebuild-maintenance: rewrite the subsection on removing packages for git #558642
Substitute the mentions of CVS with git.
Rewrite CVS commands with their git equivalents.
Remove the paragraph about deleting directories in CVS.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 28 +++++++++++++++++++++-------
1 file changed, 21 insertions(+), 7 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index d388d6d..b9c6327 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -428,20 +428,34 @@ When removing packages follow these steps:
<li>Send last rites to gentoo-dev-announce and gentoo-dev</li>
<li>Mask the package</li>
<li>Wait 30 days (or more)</li>
- <li>Remove from CVS unless the reason for removal has been fixed</li>
+ <li>Remove from the git tree unless the reason for removal has been fixed</li>
<li>Remove package.mask entry</li>
<li>Close open bugs as WONTFIX</li>
</ol>
<p>
-In order to remove a package completely from CVS, delete any files from the
-directory and commit this, CVS will take care of removing empty directories
-itself.
+Here is a list of commands that will delete <path>dev-util/pmk</path>
+from the tree:
</p>
-<pre caption="Removing a package from CVS"><comment>#</comment> <keyword>cd</keyword> app-admin
-<comment>#</comment> <keyword>cvs</keyword> rm -Rf scotty
-<comment>#</comment> <keyword>cvs</keyword> ci -m "app-admin/scotty removal (pending 21st July 2006), see #77501 for reference." scotty</pre>
+<pre caption="Removing a package from git">
+<comment>#</comment> <keyword>cd</keyword> dev-util
+<comment>#</comment> <keyword>git</keyword> rm -rf pmk
+<comment>#</comment> <keyword>git</keyword> commit --gpg-sign</pre>
+
+<p>
+An example commit message is shown below:
+</p>
+
+<pre caption="Package removal commit message">
+commit e0bbcf8291501dc7de6b4b120d4372061367dd7a
+Author: Michael Palimaka <kensington@gentoo.org>
+Date: Fri Jan 29 07:11:01 2016 +1100
+
+ dev-util/pmk: remove last-rited package
+
+ Gentoo-bug: 541522
+</pre>
</body>
</section>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 5e0ed344e5bf5cb00473cdb7470d17ca65bed4a8
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:42 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5e0ed344
ebuild-maintenance: replace "cvs commit" with "git commit" #558642
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index b9c6327..26cca2f 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -62,8 +62,8 @@ examples.
</p>
<p>
-When committing to CVS, all developers should use <c>repoman commit</c>
-instead of <c>cvs commit</c> to submit their ebuilds. Before committing,
+When committing to git, all developers should use <c>repoman commit</c>
+instead of <c>git commit</c> to submit their ebuilds. Before committing,
please run <c>repoman full</c> to make sure you didn't forget something.
</p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: f59da125396e757847130b365361786e2ebec685
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:38 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=f59da125
ebuild-maintenance: rewrite the subsection on upgrading ebuilds for git #558642
Substitute the mentions of CVS with git.
Rewrite CVS commands with their git equivalents.
Delete the reference to editing ChangeLog.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 9372895..28442a3 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -275,14 +275,14 @@ available.
<p>
If there are no new dependencies, do not remove keywords if your
-commit fails with repoman - please try a full <c>cvs update</c> and if
+commit fails with repoman - please try a full <c>git pull</c> and if
you still have problems, then commit with <c>repoman -I</c> and file a
-bug to the broken architecture, noting it in your CVS commit message.
+bug to the broken architecture, noting it in your git commit message.
</p>
<warn>
When committing, make sure that you reference any bugs in the
-ChangeLog as well as the CVS message. Failing to do so is considered
+commit message. Failing to do so is considered
to be in very poor taste and may result in disciplinary action.
</warn>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 688daafe8eacb47749056cd0e22651788e8de49a
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:40 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=688daafe
ebuild-maintenance: rewrite the subsection on removing ebuilds for git #558642
Substitute the mentions of CVS with git.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 74ef88b..d388d6d 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -396,8 +396,8 @@ entry which may be affected by your change.
<p>
When removing an ebuild make sure that no dependencies in Portage are broken
-due to the removal - additionally, your CVS commit message should explain
-clearly why the ebuild is being removed from CVS.
+due to the removal - additionally, your git commit message should explain
+clearly why the ebuild is being removed from the git repository.
</p>
<p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: c9f3c7700d81319b20521b17902542b2563413f7
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:36 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:19 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c9f3c770
ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
Remove the paragraph about adding binary files to CVS.
Replace the instances of CVS with git.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 19 +++----------------
1 file changed, 3 insertions(+), 16 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index ac68dcd..3cefdc2 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -42,22 +42,9 @@ above 20KB) which should be distributed as tarballs via the
<uri link="::general-concepts/mirrors/#suitable-download-hosts">Gentoo mirror system</uri>
so that people do not waste excessive amounts of bandwidth and hard drive
space. Also, you should not add binary (non-ASCII) files to the
-Portage CVS tree. If you need to do this in another CVS tree, for
-example, if you need to add a small PNG graphic for whatever reason,
-be sure to add it to CVS by using the <c>-kb</c> option, like so:
-</p>
-
-<pre caption="Adding binary files to CVS">
-# <i>cvs add -kb myphoto.png</i>
-</pre>
-
-<p>
-The <c>-kb</c> option tells CVS that <path>myphoto.png</path> is a binary
-file and should be treated specially. For example, merging the
-differences between two different versions of this file should not be
-allowed to happen, for obvious reasons. Also, speaking of merging
+git tree. Also, speaking of merging
changes, any patches you add to Portage should generally <e>not</e> be
-compressed. This will allow CVS to merge changes and correctly inform
+compressed. This will allow git to merge changes and correctly inform
developers of conflicts.
</p>
@@ -149,7 +136,7 @@ simply, <path>1.0-gentoo.diff</path>. Also note that the
<path>gentoo</path> extension informs people that this patch was created
by us, the Gentoo Linux developers, rather than having been grabbed from a
mailing list or somewhere else. Again, you should not compress these
-patches because CVS does not play well with binary files.
+patches.
</p>
<p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 5c0a5524b4261c497346db460eaaecd1499bd015
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:39 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5c0a5524
ebuild-maintenance: rewrite the subsection on moving ebuilds for git #558642
Rename the subsection to "moving a package" and rewrite it from scratch.
The previous workflow suggested a 2 step process whereas the new one
suggests a single git commit to contain all the changes.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 92 +++++++++++++++++++++++++++++----------------
1 file changed, 59 insertions(+), 33 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 28442a3..74ef88b 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -290,56 +290,82 @@ to be in very poor taste and may result in disciplinary action.
</section>
<section>
-<title>Moving ebuilds</title>
+<title>Moving a package</title>
<body>
<p>
-Moving ebuilds is a two-step process:
+Moving a package in the tree requires several operations. Firstly,
+the package directory needs to be moved to the correct category
+using <c>git mv</c>. After this, a new entry needs to be added to
+the latest file in <path>profiles/updates/</path> in the
+following format:
</p>
-<p>
-Firstly, you need to move the ebuild in CVS. To do this, you should
-copy the ebuild to its new location and commit that as you would with
-a <uri link="#adding-a-new-ebuild">new ebuild</uri>.
-</p>
+<pre caption="Adding an entry to updates">
+move old-category/package-name new-category/package-name
+</pre>
<p>
-After this, you should change any ebuilds which <c>DEPEND</c> on the
-old ebuild to depend on the new one. After this, should add an entry to the
-latest file in <path>profiles/updates/</path> in the Portage tree in the in
-the following format:
+Following the update entry, ebuilds that have a
+<uri link="::general-concepts/dependencies">dependency</uri>
+to this package (in other words, the reverse dependencies of
+the package to be moved) need to be updated properly.
</p>
-<pre caption="Adding an entry to updates">
-move net-misc/fwbuilder net-firewall/fwbuilder
-</pre>
-
<p>
-This example would transparently move <path>net-misc/fwbuilder</path> to
-<path>net-firewall/fwbuilder</path> if users have it installed. This
-way, users would now automatically receive updates
-for <path>net-firewall/fwbuilder</path> when they are available.
+Next is checking the files under <path>profiles/</path> such as
+<path>profiles/package.mask</path> and update them to reflect the ebuild
+move. Various eclasses automatically provide some of the dependencies upon
+inherit, so the files under <path>eclass/</path> should be checked and updated
+properly as well. Lastly, the titles of the open bugs related to the package
+should be updated.
</p>
<p>
-Once this step is concluded, you are allowed to remove the old package.
-Simply issue a <c>cvs remove -Rf $PN</c> in the package category and commit
-the changes afterwards with a meaningful commit message. Don't forget to update
-entries in files such as profiles/package.mask to reflect the new category. Finally
-remember to change the title to open bugs related to this package if needed.
+Here is an example where the package
+<path>net-misc/fwbuilder</path> is transparently moved to
+<path>net-firewall/fwbuilder</path>:
</p>
-<pre caption="Removing a package">
-net-misc # cvs rm -Rf fwbuilder
-cvs remove: use `cvs commit' to remove these files permanently
-net-misc # cvs ci -m "Moving net-misc/fwbuilder to net-firewall/fwbuilder."
+<ol>
+ <li>Issue <c>git mv net-misc/fwbuilder net-firewall/fwbuilder</c></li>
+ <li>
+ <p>
+ Add the following entry to the latest file in
+ <path>profile/updates/</path>:
+ </p>
+ <p><c>move net-misc/fwbuilder net-firewall/fwbuilder</c></p>
+ </li>
+ <li>Update the reverse dependencies of the package</li>
+ <li>
+ Update <path>profiles/package.mask</path> and other related files under
+ <path>profiles/</path>
+ </li>
+ <li>Check the eclasses that may be referencing the package</li>
+ <li>
+ Stage all the changed files using <c>git add</c>. For example: <c>git add
+ profiles/package.mask</c>
+ </li>
+ <li>
+ Commit all the changes in one commit using: <c>git commit --gpg-sign</c>
+ </li>
+ <li>Update any open bugs related to the package</li>
+</ol>
+
+<p>
+It is very important to commit all the changes in a single commit to ensure
+that no breakage occurs. The commit message should follow a format similar
+to the following:
+</p>
+
+<pre>
+commit d391643289097344a0b18ab2665bb26198a0e3a1
+Author: Guilherme Amadio <amadio@gentoo.org>
+Date: Tue Nov 3 20:26:52 2015 +0100
+
+ media-fonts/nanumfont: renamed to media-fonts/nanum
</pre>
-<note>
-CVS cannot destroy directories: it will simply not re-create them if
-they are blank, providing you use CVS with the <c>-P</c> flag.
-</note>
-
</body>
</section>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: 1ea5569645f171c2f60a3cbdb987c23ddfe7cccf
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:37 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:20 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1ea55696
ebuild-maintenance: rewrite the subsection on commit policy for git #558642
Remove the mention of updating the ChangeLog.
Remove the mention of file conflicts during commit as CVS keeps track of
files whereas git keeps track of changesets.
Add a note regarding commit atomicity: Git commits are always atomic, so
combining package.mask/license changes with ebuild changes in the same
commit does not violate atomicity. However, there is no way to accomplish
this using repoman commit.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 3cefdc2..9372895 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -96,7 +96,7 @@ work on those architectures.
</subsection>
<subsection>
-<title>CVS Commit Policy</title>
+<title>Git Commit Policy</title>
<body>
<ul>
@@ -105,15 +105,18 @@ work on those architectures.
<li>Always test that <path>package.mask</path> is okay by doing
<c>emerge --pretend mypkg</c> before you commit and check
that it doesn't contain any conflicts.</li>
-<li>Always update the <path>ChangeLog</path> before you commit.</li>
-<li>Always commit the updated <path>package.mask</path> before
-the updated package, in case conflicts occur while you commit
-<path>package.mask</path>.</li>
+<li>Always commit the updated <path>package.mask</path> before
+the updated package.</li>
<li>Always do atomic commits; if you commit a package with a new license,
or that is masked, then first commit the revised <path>package.mask</path> and/or license,
then commit the ebuild, <path>ChangeLog</path>, patches
and <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> all in <b>one</b> go
-to avoid breaking users' installations.</li>
+.</li>
+<note> Although the set of changes in a single git commit is atomic, and
+combining <path>package.mask</path>/license changes with ebuild changes in a
+single commit wouldn't break atomicity, it is not currently possible to do so
+using <c>repoman commit</c>.</note>
+<!-- See: https://bugs.gentoo.org/show_bug.cgi?id=390651 -->
</ul>
</body>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-02-05 12:59 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-02-05 12:59 UTC (permalink / raw
To: gentoo-commits
commit: fb7db633772884dd156c1fe0cb2c22e312a8a248
Author: Gokturk Yuksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Thu Feb 4 00:57:48 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Feb 5 12:58:22 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fb7db633
ebuid-maintenance: add a new section called "Git Commit Message Format" #558642
Most of this section is derived from the "Commit message format"
subsection of the "Gentoo git workflow" wiki page
<https://wiki.gentoo.org/wiki/Gentoo_git_workflow>, which is released
under the CC-BY-SA-3.0 license.
Parts of the old ChangeLog section in the devmanual are also included,
as well as feedback from developers on the gentoo-dev <AT> g.o mailing list.
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Reviewed-by: NP-Hardass <np-hardass <AT> gentoo.org>
Signed-off-by: Gokturk Yuksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 113 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 113 insertions(+)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 26cca2f..5b2abee 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -96,6 +96,119 @@ work on those architectures.
</subsection>
<subsection>
+<title>Git Commit Message Format</title>
+<body>
+
+<p>
+It is important to format the commit messages properly so that they
+communicate the changes to the reader in a clear and concise
+way. Additionally, consistency in message format allows for easier
+parsing by external tools. The first line of the commit message should
+contain a brief summary of the changes, followed by an empty new
+line. From the third line onward should be a detailed, multiline
+explanation of the changes introduced by the commit. At the very end,
+auxiliary information such as the bugs related to the commit,
+contributors, and reviewers should be listed using RFC822/git style
+tags. The length of the lines in the message should be 70-75
+characters at maximum.
+</p>
+
+<p>
+The summary line should start with referencing what is affected by the
+change followed by a colon ':' character. Use the rules in the
+following list to determine the proper format based on what has
+changed, substituting the package, category and eclass names
+appropriately:
+
+<ul>
+<li><c>${CATEGORY}/${PN}:</c>Single Package (Note that <c>repoman commit</c>
+automatically inserts this for you)</li>
+<li><c>${CATEGORY}:</c> Package Category</li>
+<li><c>profiles:</c> Profile Directory</li>
+<li><c>${ECLASS}.eclass:</c> Eclass Directotry</li>
+<li><c>licenses:</c> Licenses Directory</li>
+<li><c>metadata:</c> Metadata Directory</li>
+</ul>
+
+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
+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
+keywords are added/removed.
+
+<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
+configured to use a different character for comments by changing the
+<c>commentchar</c> option.
+</warning>
+</p>
+
+<p>
+For non-trivial commits, the message should contain a detailed
+explanation of what the commit intends to change, why it is required,
+and how it is accomplished, along with any other supplementary
+information.
+</p>
+
+<p>
+Finally the commit message should list auxiliary information such as
+people who are involved in authoring, suggesting, reviewing and
+testing the changes, and revelant bugs. Use RFC822/git style tags as
+explained in the
+<uri link="https://www.kernel.org/doc/Documentation/SubmittingPatches">
+Linux Kernel patch guideline</uri>. Additionally, the following tags
+are 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>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>
+<li><c>RepoMan-Options:</c> This is automatically inserted by
+<c>repoman commit</c> and records the options passed to repoman (such
+as --force) for the commit.</li>
+</ul>
+</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
+of their privacy: some users prefer to be only known by a
+nickname. Take advantage of the tags such as <c>Suggested-By</c> or
+<c>Reported-By:</c>when entering such information to the commit
+message.
+</p>
+
+<p>
+An example commit message is shown below:
+</p>
+
+<pre caption="Example commit message">
+app-misc/foo: version bump to 0.5
+
+This also adds a new USE flag 'bar' which controls the
+new bar functionality introduced with this version.
+
+Gentoo-Bug: 01234
+</pre>
+
+</body>
+</subsection>
+
+<subsection>
<title>Git Commit Policy</title>
<body>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-04-19 10:40 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-04-19 10:40 UTC (permalink / raw
To: gentoo-commits
commit: 7ecc327a201853f40f04dbb2227a3f34a84ea7ea
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Mon Apr 4 04:34:28 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Apr 19 10:39:53 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7ecc327a
ebuild-maintenance: s/herd/project/ per GLEP 67 #572144
Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=572144
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 5b2abee..a299bf2 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -281,7 +281,18 @@ which is often more convenient.
<section>
<title>Touching other developers ebuilds</title>
<body>
-<p>Usually you don't just change other developers ebuilds without permission unless you know that developer does not mind or if you are part of the herd involved in maintenance (this information can typically be found in metadata.xml). Start with filing a bug or trying to catch them on IRC or via email. Sometimes you cannot reach them, or there is no response to your bug. It's a good idea to consult other developers on how to handle the situation, especially if it's a critical issue that needs to be handled ASAP. Otherwise a soft limit of 2 to 4 weeks depending on the severity of the bug is an acceptable time frame before you go ahead and fix it yourself.</p>
+<p>
+Usually you don't just change other developers ebuilds without
+permission unless you know that developer does not mind or if you are
+part of the project involved in maintenance (this information can
+typically be found in metadata.xml). Start with filing a bug or trying
+to catch them on IRC or via email. Sometimes you cannot reach them, or
+there is no response to your bug. It's a good idea to consult other
+developers on how to handle the situation, especially if it's a
+critical issue that needs to be handled ASAP. Otherwise a soft limit
+of 2 to 4 weeks depending on the severity of the bug is an acceptable
+time frame before you go ahead and fix it yourself.
+</p>
<important> Common sense dictates to us that toolchain/base-system/core packages and eclasses or anything else which is delicate (e.g. glibc) or widely used (e.g. gtk+) should usually be left to those maintainers. If in doubt, don't touch it.</important>
<p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-04-23 19:26 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2016-04-23 19:26 UTC (permalink / raw
To: gentoo-commits
commit: 2d2824212283fd65b01f3b01c80890a721dc0ebf
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Wed Apr 20 04:35:59 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Sat Apr 23 19:24:44 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2d282421
ebuild-maintenance: remove the mention of ChangeLog
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index a299bf2..66d736f 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -222,7 +222,7 @@ that it doesn't contain any conflicts.</li>
the updated package.</li>
<li>Always do atomic commits; if you commit a package with a new license,
or that is masked, then first commit the revised <path>package.mask</path> and/or license,
-then commit the ebuild, <path>ChangeLog</path>, patches
+then commit the ebuild, patches
and <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> all in <b>one</b> go
.</li>
<note> Although the set of changes in a single git commit is atomic, and
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-04-24 0:47 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2016-04-24 0:47 UTC (permalink / raw
To: gentoo-commits
commit: 41ede153d18e712ea0686f23f3571d2e444f1b5f
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Wed Apr 20 06:45:16 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Sun Apr 24 00:21:39 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=41ede153
ebuild-maintenance: information for updating metadata on package move/removal
Per GLEP 68, metadata.xml supports referencing other packages using
the <pkg> tag. It also allows package atoms to be specified as part of
the "restrict" attribute for various tags. These references should be
properly updated/removed upon package moves and removals.
Reported-by: NP-Hardass <NP-Hardass <AT> gentoo.org>
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 66d736f..7cbe755 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -441,8 +441,12 @@ Next is checking the files under <path>profiles/</path> such as
<path>profiles/package.mask</path> and update them to reflect the ebuild
move. Various eclasses automatically provide some of the dependencies upon
inherit, so the files under <path>eclass/</path> should be checked and updated
-properly as well. Lastly, the titles of the open bugs related to the package
-should be updated.
+properly. If the package metadata.xml has tags with <c>restrict</c>
+attribute, they should be updated to reflect the move. The
+metadata.xml for various packages may contain references to the
+package being moved using the <c><pkg></c> tag which need to be
+updated accordingly as well. Lastly, the titles of the open bugs
+related to the package should be updated.
</p>
<p>
@@ -467,6 +471,12 @@ Here is an example where the package
</li>
<li>Check the eclasses that may be referencing the package</li>
<li>
+ Update all the
+ <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri>
+ files which contain a reference to this package using the
+ <c><pkg></c> tag or the <c>restrict</c> attribute.
+ </li>
+ <li>
Stage all the changed files using <c>git add</c>. For example: <c>git add
profiles/package.mask</c>
</li>
@@ -554,6 +564,11 @@ When removing packages follow these steps:
<li>Wait 30 days (or more)</li>
<li>Remove from the git tree unless the reason for removal has been fixed</li>
<li>Remove package.mask entry</li>
+ <li>
+ Remove the <c><pkg></c> tags referencing this package in the
+ <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri>
+ files of other packages.
+ </li>
<li>Close open bugs as WONTFIX</li>
</ol>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-05-01 3:49 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2016-05-01 3:49 UTC (permalink / raw
To: gentoo-commits
commit: 6e91b50253398d874fed5addbc08a2d8852d4fe3
Author: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
AuthorDate: Sun May 1 03:32:38 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> binghamton <DOT> edu>
CommitDate: Sun May 1 03:45:31 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6e91b502
ebuild-maintenance: fix the link to the bugzilla advanced search tab #539630
The patch is the courtesy of Fernando (likewhoa) submitted in the bug.
Gentoo-Bug: https://bugs.gentoo.org/539630
Signed-off-by: Göktürk Yüksek <gokturk <AT> binghamton.edu>
ebuild-maintenance/text.xml | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 7cbe755..a2fe6b8 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -26,9 +26,8 @@ been added to the Portage tree. Go to <uri
link="https://bugs.gentoo.org/">bugs.gentoo.org</uri>, choose query and select
Advanced Search; as product select <e>Gentoo Linux</e>, as component select
<e>ebuilds</e>. In the search field put the name of the ebuild and as status
-select NEW, ASSIGNED, REOPENED and RESOLVED (RESOLVED is important), then
-submit the query. For you lazy people, click <uri
-link="https://bugs.gentoo.org/query.cgi?product=Gentoo%20Linux&component=Ebuilds&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED">here</uri>.
+select all possible fields, then submit the query. For you lazy people, click
+<uri link="https://bugs.gentoo.org/query.cgi?format=advanced&product=Gentoo%20Linux&component=New%20Ebuilds&bug_Status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=RESOLVED&bug_status=VERIFIED">here</uri>.
</p>
<p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-05-22 8:35 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-05-22 8:35 UTC (permalink / raw
To: gentoo-commits
commit: 158d182b0142a90aae7b6c860c923659c78b3f97
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed May 18 12:07:32 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun May 22 08:35:41 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=158d182b
ebuild-maintenance: Add news items to agenda for package moves.
This policy is already outlined in GLEP 42.
Bug: 583404
ebuild-maintenance/text.xml | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index a2fe6b8..3e30933 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -482,6 +482,11 @@ Here is an example where the package
<li>
Commit all the changes in one commit using: <c>git commit --gpg-sign</c>
</li>
+ <li>
+ Update any <uri link="::general-concepts/news">news items</uri>
+ referencing the package in a <c>Display-If-Installed</c> header
+ or in the item's body (and increment their <c>Revision</c>).
+ </li>
<li>Update any open bugs related to the package</li>
</ol>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-08-18 9:01 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2016-08-18 9:01 UTC (permalink / raw
To: gentoo-commits
commit: a3e0f924a6e9c556386b4be177e14a96313610b5
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Aug 18 09:00:31 2016 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Aug 18 09:00:31 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a3e0f924
ebuild-maintenance: <warning/> rather than <warn/>.
ebuild-maintenance/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 3e30933..0694a51 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -403,11 +403,11 @@ you still have problems, then commit with <c>repoman -I</c> and file a
bug to the broken architecture, noting it in your git commit message.
</p>
-<warn>
+<warning>
When committing, make sure that you reference any bugs in the
commit message. Failing to do so is considered
to be in very poor taste and may result in disciplinary action.
-</warn>
+</warning>
</body>
</section>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2016-11-20 20:46 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2016-11-20 20:46 UTC (permalink / raw
To: gentoo-commits
commit: b7e1c71f9ecc7edb3d68e43cec9ba5f75664f495
Author: Wim Muskee <wimmuskee <AT> gmail <DOT> com>
AuthorDate: Sat Nov 19 09:31:34 2016 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sun Nov 20 20:46:31 2016 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b7e1c71f
ebuild-maintenance: update fedora repository link, #581608
ebuild-maintenance/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 3ccb62f..6d2e813 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -56,7 +56,7 @@ not sure how to get it to work, check some other distributions that have
done their own versions of the package. You can check
<uri link="http://cvs.mandriva.com/cgi-bin/viewvc.cgi/SPECS/">Mandriva</uri>
or <uri link="http://www.debian.org/distrib/packages">Debian</uri> or
-<uri link="http://cvs.fedora.redhat.com/">Fedora</uri> for some
+<uri link="http://pkgs.fedoraproject.org/cgit/rpms/">Fedora</uri> for some
examples.
</p>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2017-01-22 20:45 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2017-01-22 20:45 UTC (permalink / raw
To: gentoo-commits
commit: e098b2f260ebd9241be932dfcf93feb5db9d344b
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Sun Jan 22 20:41:23 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sun Jan 22 20:41:23 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e098b2f2
ebuild-maintenance: fix the kernel patch submitting guidelines link
Reported-By: M. J. Everitt <m.j.everitt <AT> iee.org>
ebuild-maintenance/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 6d2e813..859b473 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -159,7 +159,7 @@ Finally the commit message should list auxiliary information such as
people who are involved in authoring, suggesting, reviewing and
testing the changes, and revelant bugs. Use RFC822/git style tags as
explained in the
-<uri link="https://www.kernel.org/doc/Documentation/SubmittingPatches">
+<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:
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2017-07-29 20:48 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2017-07-29 20:48 UTC (permalink / raw
To: gentoo-commits
commit: 9456029d947d7ef31d1ac3c7b4e9b526beb630be
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Sat Jul 29 20:46:10 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Sat Jul 29 20:46:10 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9456029d
ebuild-maintenance: remove uses of <comment> and <keyword>
They are renmants of the handbook and have no use in devmanual. The
generated HTML outputs are identical with and without these tags.
ebuild-maintenance/text.xml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 859b473..e1bebaf 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -582,9 +582,10 @@ from the tree:
</p>
<pre caption="Removing a package from git">
-<comment>#</comment> <keyword>cd</keyword> dev-util
-<comment>#</comment> <keyword>git</keyword> rm -rf pmk
-<comment>#</comment> <keyword>git</keyword> commit --gpg-sign</pre>
+# cd dev-util
+# git rm -rf pmk
+# git commit --gpg-sign
+</pre>
<p>
An example commit message is shown below:
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2017-09-25 4:40 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2017-09-25 4:40 UTC (permalink / raw
To: gentoo-commits
commit: 4328a842d38113a60a22349636bd5c5285978c1e
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Wed Sep 6 10:28:06 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Sep 25 04:32:13 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4328a842
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).
ebuild-maintenance/text.xml | 28 +++++++++++++++++++---------
1 file 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
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2017-09-25 4:40 Göktürk Yüksek
0 siblings, 0 replies; 21+ messages in thread
From: Göktürk Yüksek @ 2017-09-25 4:40 UTC (permalink / raw
To: gentoo-commits
commit: 790ba9417997cc06d22d9611b2f2c3b00b3b77ec
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Mon Sep 25 04:38:31 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Mon Sep 25 04:38:31 2017 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=790ba941
ebuild-maintenance: replace the tags in the example for referencing bugs
The tag 'Gentoo-Bug:' is not valid anymore. Replace the use of this
tag with examples of 'Bug:' and 'Closes:'.
ebuild-maintenance/text.xml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index fe56f7a..0a94d9c 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -211,7 +211,8 @@ app-misc/foo: version bump to 0.5
This also adds a new USE flag 'bar' which controls the
new bar functionality introduced with this version.
-Gentoo-Bug: 01234
+Bug: https://bugs.gentoo.org/00000
+Closes: https://bugs.gentoo.org/00001
</pre>
</body>
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/
@ 2020-01-23 8:40 Ulrich Müller
0 siblings, 0 replies; 21+ messages in thread
From: Ulrich Müller @ 2020-01-23 8:40 UTC (permalink / raw
To: gentoo-commits
commit: 43e98554445b4553178ca26a1931308c8187a835
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Jan 23 08:37:07 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Jan 23 08:37:07 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=43e98554
ebuild-maintenance: Delete dead include.
Fixes:450692994d68bed141e324284ac9be671f8c84bf
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/text.xml | 1 -
1 file changed, 1 deletion(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index a9f295c..6c8d562 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -26,5 +26,4 @@ familiar with.
<include href="collisions/"/>
<include href="removal/"/>
<include href="stabilization/"/>
-<include href="maintenance-tasks/"/>
</guide>
^ permalink raw reply related [flat|nested] 21+ messages in thread
end of thread, other threads:[~2020-01-23 8:40 UTC | newest]
Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-01-22 20:45 [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/ Göktürk Yüksek
-- strict thread matches above, loose matches on Subject: below --
2020-01-23 8:40 Ulrich Müller
2017-09-25 4:40 Göktürk Yüksek
2017-09-25 4:40 Göktürk Yüksek
2017-07-29 20:48 Göktürk Yüksek
2016-11-20 20:46 Göktürk Yüksek
2016-08-18 9:01 Ulrich Müller
2016-05-22 8:35 Ulrich Müller
2016-05-01 3:49 Göktürk Yüksek
2016-04-24 0:47 Göktürk Yüksek
2016-04-23 19:26 Göktürk Yüksek
2016-04-19 10:40 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2016-02-05 12:59 Ulrich Müller
2015-05-09 15:22 Ulrich Müller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox