* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2018-01-03 4:51 Göktürk Yüksek
0 siblings, 0 replies; 11+ messages in thread
From: Göktürk Yüksek @ 2018-01-03 4:51 UTC (permalink / raw
To: gentoo-commits
commit: 30c77a7b4c4beab3e93ab32756a2047c6e2d0d77
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Sat Oct 14 18:27:48 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Jan 3 04:38:30 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=30c77a7b
ebuild-maintenance/git: Add new section on repoman commit/full
ebuild-maintenance/git/text.xml | 43 ++++++++++++++++++++++++++++++++++-------
1 file changed, 36 insertions(+), 7 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 59f1833..dfc3d5b 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -112,12 +112,46 @@ the historical commits after the initial git commit.
<body>
<subsection>
+<title>Committing and verifying commits</title>
+<body>
+
+<p>
+The recommended way of committing to the Gentoo repository is to use <c>repoman
+commit</c>. It automatically performs the necessary QA checks on the package
+being committed and has other features helping with the Gentoo workflow.
+However, it is currently limited to creating a single commit to a single
+package.
+</p>
+
+<p>
+For any other use case, <c>git commit</c> and other git commands need to be
+used. The valid uses of git include:
+</p>
+
+<ul>
+<li>creating commits spanning multiple packages and/or multiple areas
+of the Gentoo repository (eclasses, licenses, profiles…),</li>
+<li>amending a commit created via <c>repoman commit</c> with additional files
+or fixups,</li>
+<li>combining multiple commits created via <c>repoman commit</c> using <c>git
+rebase</c>.</li>
+</ul>
+
+<p>
+Whenever repoman is not used to commit, you need to manually verify all
+packages affected by the commit using <c>repoman full</c>. Since repoman
+is not aware of staged changes, please make sure that all files are included
+in the commit.
+</p>
+
+</body>
+</subsection>
+
+<subsection>
<title>Git Commit Policy</title>
<body>
<ul>
-<li>Always run <c>repoman scan</c> before you commit.</li>
-<li>Please run <c>repoman full</c> before you commit.</li>
<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>
@@ -128,11 +162,6 @@ or that is masked, then first commit the revised <path>package.mask</path> and/o
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
-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] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2018-01-03 4:51 Göktürk Yüksek
0 siblings, 0 replies; 11+ messages in thread
From: Göktürk Yüksek @ 2018-01-03 4:51 UTC (permalink / raw
To: gentoo-commits
commit: 8f6095d523d5e36ddff1f089cf612fd5fe74e75a
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Sat Oct 14 10:18:42 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Jan 3 04:29:35 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8f6095d5
ebuild-maintenance/git: Include instructions for setting up the checkout
ebuild-maintenance/git/text.xml | 102 ++++++++++++++++++++++++++++++++++++++--
1 file changed, 99 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 172e22c..2070217 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -5,12 +5,108 @@
<body>
<p>
-This guide covers git usage instructions and policies specific to Gentoo
-ebuild development. It assumes that the readers possess basic git
-knowledge. For a generic guide, please see the official
+This guide covers git usage instructions and policies specific to Gentoo ebuild
+development. It assumes that the readers possess basic git knowledge.
+For a generic guide, please see the official
<uri link="https://git-scm.com/book/">git book</uri>.
</p>
+
+<section>
+<title>Preparing a development checkout</title>
+<body>
+
+<subsection>
+<title>Cloning the gentoo.git repository</title>
+<body>
+
+<p>
+The ebuild development happens on the official git repository. You can push
+your changes only through the SSH protocol. Therefore, clone the repository
+using:
+</p>
+
+<pre>
+git clone git@git.gentoo.org:repo/gentoo.git
+</pre>
+
+<p>
+If you do not have SSH access to the Gentoo git service, you can use the anongit
+mirror for read-only access instead:
+</p>
+
+<pre>
+git clone https://anongit.gentoo.org/git/repo/gentoo.git
+</pre>
+
+<p>
+Normally git will fetch the complete history from the start of git repository
+(Aug 2015). This can require a significant amount of disk space. If you do not
+need the full history, you can use the <c>--depth</c> option to create a shallow
+clone, including only a subset containing the the newest commits. For example,
+<c>--depth=50</c> will include the 50 newest commits.
+</p>
+
+<p>
+Please note that git version 1.9 or newer is required to push when using
+a shallow clone.
+</p>
+
+</body>
+</subsection>
+
+<subsection>
+<title>Configuration specific to the Gentoo repository</title>
+<body>
+
+<p>
+To ensure that the Gentoo policies are followed, you should set the following
+configuration variables:
+</p>
+
+<pre caption="Configuring git for the Gentoo repository">
+git config --local user.name "${YOUR_FULL_NAME}"
+# use your @gentoo.org address even if you have a different default
+git config --local user.email "${YOUR_NICKNAME}@gentoo.org"
+
+# enable commit and push signing
+git config --local user.signingkey "0x${LONG_OPENPGP_KEY_ID}"
+git config --local commit.gpgsign 1
+git config --local push.gpgsign 1
+
+# prevent implicit merges on 'git pull'
+git config --local pull.ff only
+</pre>
+
+</body>
+</subsection>
+
+<subsection>
+<title>Grafting converted CVS history into the clone</title>
+<body>
+
+<p>
+To include the converted CVS history in the git repository, you can
+graft it into the repository:
+</p>
+
+<pre caption="Grafting the history into git">
+git remote add history https://anongit.gentoo.org/git/repo/gentoo/historical.git/
+git fetch history
+git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d history/master
+</pre>
+
+<p>
+Once this is done, git commands such as <c>git log</c> will include
+the historical commits after the initial git commit.
+</p>
+
+</body>
+</subsection>
+
+</body>
+</section>
+
</body>
</chapter>
</guide>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2018-01-03 4:51 Göktürk Yüksek
0 siblings, 0 replies; 11+ messages in thread
From: Göktürk Yüksek @ 2018-01-03 4:51 UTC (permalink / raw
To: gentoo-commits
commit: 5121332b708a733b2b52975a1100b847dcb0c60a
Author: Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Sat Oct 14 18:45:55 2017 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Wed Jan 3 04:42:55 2018 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5121332b
ebuild-maintenance/git: Try to describe atomic commits better (GLEP 66)
ebuild-maintenance/git/text.xml | 50 ++++++++++++++++++++++++++++++-----------
1 file changed, 37 insertions(+), 13 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index dfc3d5b..c61589d 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -148,21 +148,45 @@ in the commit.
</subsection>
<subsection>
-<title>Git Commit Policy</title>
+<title>Atomic commits</title>
<body>
-<ul>
-<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 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, patches
-and <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> all in <b>one</b> go
-.</li>
-</ul>
+<p>
+Whenever possible, use atomic commits. Try to split your changes into logical
+commits, abiding by the following three rules as much as possible:
+</p>
+
+<ol>
+<li>
+Do not include multiple irrelevant changes in a single commit. However, make
+sure not to split relevant changes unnecessarily. For example, if a version bump
+requires changes in the ebuild, it is correct to perform them in a single
+commit. However, if you are fixing an additional bug that has been present
+in the previous version, the fix belongs in a separate commit.
+</li>
+
+<li>
+Split commits at logical unit boundaries. When updating multiple packages,
+preferably use a single commit for each package. Avoid combining changes
+to ebuilds, eclasses, licenses, profiles etc. in a single commit. However,
+do not split relevant or interdependent changes within a single package.
+</li>
+
+<li>
+Avoid creating commits introducing a temporary breakage. Unless impossible,
+add packages in dependency install order. Add licenses before the packages
+needing them. Commit <path>package.mask</path> and other profile changes before
+ebuilds relying on them. Usually it is also acceptable to include those changes
+along with the commit adding the package.
+</li>
+</ol>
+
+<p>
+Please note that revision bumps count as side effects of the changes requiring
+them and do not belong in separate commits. When doing multiple irrelevant
+changes that require a revision bump, it is only necessary to bump the revision
+in the first commit in the series introduced by a single push.
+</p>
</body>
</subsection>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2019-10-29 20:49 Göktürk Yüksek
0 siblings, 0 replies; 11+ messages in thread
From: Göktürk Yüksek @ 2019-10-29 20:49 UTC (permalink / raw
To: gentoo-commits
commit: fdc4594387073ec16b6021b1a858fffd5855d18a
Author: Wim Muskee <wimmuskee <AT> gmail <DOT> com>
AuthorDate: Wed Oct 23 19:19:10 2019 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Oct 29 20:30:21 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fdc45943
ebuild-maintenance/git: add sign-off for Certificate of Origin
Bug: https://bugs.gentoo.org/668686
Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/113
Acked-by: Michał Górny <mgorny <AT> gentoo.org>
Signed-off-by: Wim Muskee <wimmuskee <AT> gmail.com>
Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index c61589d..fb09de7 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -141,7 +141,11 @@ rebase</c>.</li>
Whenever repoman is not used to commit, you need to manually verify all
packages affected by the commit using <c>repoman full</c>. Since repoman
is not aware of staged changes, please make sure that all files are included
-in the commit.
+in the commit. Also when not using repoman, you must perform a manual sign-off
+to the <uri link="https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin">
+Certificate of Origin</uri> using the <c>-s</c> or <c>--signoff</c> option
+with your git commit commands. Make sure you have read and understand the
+actual Certificate.
</p>
</body>
@@ -205,8 +209,9 @@ 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.
+tags. The sign-off agreement will be added there as well when applied
+with the commit action. The length of the lines in the message should
+be 70-75 characters at maximum.
</p>
<p>
@@ -310,6 +315,7 @@ new bar functionality introduced with this version.
Bug: https://bugs.gentoo.org/00000
Closes: https://bugs.gentoo.org/00001
+Signed-off-by: Alice Bar <a.bar@example.org>
</pre>
</body>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2020-01-14 20:36 Göktürk Yüksek
0 siblings, 0 replies; 11+ messages in thread
From: Göktürk Yüksek @ 2020-01-14 20:36 UTC (permalink / raw
To: gentoo-commits
commit: 95251a20ed3b8d7de99b355a6f02e9065bf8177a
Author: Wim Muskee <wimmuskee <AT> gmail <DOT> com>
AuthorDate: Fri Jan 3 08:46:31 2020 +0000
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Jan 14 20:35:46 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=95251a20
ebuild-maintenance/git: merge different references to #BUG-ID
Closes: https://github.com/gentoo/devmanual/pull/133
Signed-off-by: Wim Muskee <wimmuskee <AT> gmail.com>
Signed-off-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 12 +++---------
1 file 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>
@@ -285,12 +285,6 @@ automatically with reference to the commit.</li>
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
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2021-02-23 8:29 Ulrich Müller
0 siblings, 0 replies; 11+ messages in thread
From: Ulrich Müller @ 2021-02-23 8:29 UTC (permalink / raw
To: gentoo-commits
commit: 396932f9fbb041b273da46b8000728a28e99de52
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Feb 23 08:21:53 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Feb 23 08:21:53 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=396932f9
ebuild-maintenance/git: Write tags in the same way as GLEP 66 does
Namely, Suggested-by: and Reported-by: with lowercase "by".
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index d58b35f..5240f6a 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -289,9 +289,9 @@ as --force) for the commit.</li>
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
+of their privacy: some users prefer to be only known by a nickname.
+Take advantage of tags such as <c>Suggested-by:</c> or
+<c>Reported-by:</c> when entering such information to the commit
message.
</p>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2021-03-30 16:10 Ulrich Müller
0 siblings, 0 replies; 11+ messages in thread
From: Ulrich Müller @ 2021-03-30 16:10 UTC (permalink / raw
To: gentoo-commits
commit: b505dd794cbf9f428f569e9c892c54e580f6a3e7
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:29:53 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:00:52 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b505dd79
ebuild-maintenance/git: reference pkgcheck scan --commits and pkgdev
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 29 +++++++++++++++--------------
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 5240f6a..fc2738a 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -113,10 +113,10 @@ the historical commits after the initial git commit.
<p>
The recommended way of committing to the Gentoo repository is to use <c>repoman
-commit</c>. It automatically performs the necessary QA checks on the package
-being committed and has other features helping with the Gentoo workflow.
-However, it is currently limited to creating a single commit to a single
-package.
+commit</c> or <c>pkgdev commit</c> (then <c>pkgdev push</c>). It automatically
+performs the necessary QA checks on the package being committed and has other
+features helping with the Gentoo workflow. However, <c>repoman</c> is currently
+limited to creating a single commit to a single package.
</p>
<p>
@@ -127,17 +127,18 @@ used. The valid uses of git include:
<ul>
<li>creating commits spanning multiple packages and/or multiple areas
of the Gentoo repository (eclasses, licenses, profiles…),</li>
-<li>amending a commit created via <c>repoman commit</c> with additional files
-or fixups,</li>
-<li>combining multiple commits created via <c>repoman commit</c> using <c>git
-rebase</c>.</li>
+<li>amending a commit created via <c>repoman commit</c> or <c>pkgdev commit</c>
+with additional files or fixups,</li>
+<li>combining multiple commits created via <c>repoman commit</c> or
+<c>pkgdev commit</c> using <c>git rebase</c>.</li>
</ul>
<p>
-Whenever repoman is not used to commit, you need to manually verify all
-packages affected by the commit using <c>repoman full</c>. Since repoman
-is not aware of staged changes, please make sure that all files are included
-in the commit. Also when not using repoman, you must perform a manual sign-off
+Whenever <c>repoman</c> or <c>pkgdev</c> is not used to commit, you need to
+manually verify all packages affected by the commit using <c>repoman full</c> or
+<c>pkgcheck scan --commits</c>. When using <c>repoman</c>, it won't be aware of
+staged changes, so ensure that all files are included in the commit.
+Also, when using <c>git</c> manually, you must perform a manual sign-off
to the <uri link="https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin">
Certificate of Origin</uri> using the <c>-s</c> or <c>--signoff</c> option
with your git commit commands. Make sure you have read and understand the
@@ -219,8 +220,8 @@ appropriately:
</p>
<ul>
-<li><c>${CATEGORY}/${PN}:</c>Single Package (Note that <c>repoman commit</c>
-automatically inserts this for you)</li>
+<li><c>${CATEGORY}/${PN}:</c> Single Package (Note that <c>repoman commit</c>
+and <c>pkgdev commit</c> will automatically insert 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>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2021-03-30 16:10 Ulrich Müller
0 siblings, 0 replies; 11+ messages in thread
From: Ulrich Müller @ 2021-03-30 16:10 UTC (permalink / raw
To: gentoo-commits
commit: 1536e0fe2f087a555580b9f21de8162e08caa890
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 30 16:09:41 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:09:41 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1536e0fe
ebuild-maintenance/git: Formatting fixes
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 125 ++++++++++++++++++++++------------------
1 file changed, 69 insertions(+), 56 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index fc2738a..0cad9bf 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -2,8 +2,8 @@
<guide self="ebuild-maintenance/git/">
<chapter>
<title>Git for Gentoo Developers</title>
-
<body>
+
<p>
This guide covers git usage instructions and policies specific to Gentoo ebuild
development. It assumes that the readers possess basic git knowledge.
@@ -125,12 +125,18 @@ used. The valid uses of git include:
</p>
<ul>
-<li>creating commits spanning multiple packages and/or multiple areas
-of the Gentoo repository (eclasses, licenses, profiles…),</li>
-<li>amending a commit created via <c>repoman commit</c> or <c>pkgdev commit</c>
-with additional files or fixups,</li>
-<li>combining multiple commits created via <c>repoman commit</c> or
-<c>pkgdev commit</c> using <c>git rebase</c>.</li>
+ <li>
+ creating commits spanning multiple packages and/or multiple areas of the
+ Gentoo repository (eclasses, licenses, profiles…),
+ </li>
+ <li>
+ amending a commit created via <c>repoman commit</c> or <c>pkgdev commit</c>
+ with additional files or fixups,
+ </li>
+ <li>
+ combining multiple commits created via <c>repoman commit</c> or
+ <c>pkgdev commit</c> using <c>git rebase</c>.
+ </li>
</ul>
<p>
@@ -138,8 +144,8 @@ Whenever <c>repoman</c> or <c>pkgdev</c> is not used to commit, you need to
manually verify all packages affected by the commit using <c>repoman full</c> or
<c>pkgcheck scan --commits</c>. When using <c>repoman</c>, it won't be aware of
staged changes, so ensure that all files are included in the commit.
-Also, when using <c>git</c> manually, you must perform a manual sign-off
-to the <uri link="https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin">
+Also, when using <c>git</c> manually, you must perform a manual sign-off to the
+<uri link="https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin">
Certificate of Origin</uri> using the <c>-s</c> or <c>--signoff</c> option
with your git commit commands. Make sure you have read and understand the
actual Certificate.
@@ -158,28 +164,26 @@ commits, abiding by the following three rules as much as possible:
</p>
<ol>
-<li>
-Do not include multiple irrelevant changes in a single commit. However, make
-sure not to split relevant changes unnecessarily. For example, if a version bump
-requires changes in the ebuild, it is correct to perform them in a single
-commit. However, if you are fixing an additional bug that has been present
-in the previous version, the fix belongs in a separate commit.
-</li>
-
-<li>
-Split commits at logical unit boundaries. When updating multiple packages,
-preferably use a single commit for each package. Avoid combining changes
-to ebuilds, eclasses, licenses, profiles etc. in a single commit. However,
-do not split relevant or interdependent changes within a single package.
-</li>
-
-<li>
-Avoid creating commits introducing a temporary breakage. Unless impossible,
-add packages in dependency install order. Add licenses before the packages
-needing them. Commit <c>package.mask</c> and other profile changes before
-ebuilds relying on them. Usually it is also acceptable to include those changes
-along with the commit adding the package.
-</li>
+ <li>
+ Do not include multiple irrelevant changes in a single commit. However,
+ make sure not to split relevant changes unnecessarily. For example, if a
+ version bump requires changes in the ebuild, it is correct to perform them
+ in a single commit. However, if you are fixing an additional bug that has
+ been present in the previous version, the fix belongs in a separate commit.
+ </li>
+ <li>
+ Split commits at logical unit boundaries. When updating multiple packages,
+ preferably use a single commit for each package. Avoid combining changes
+ to ebuilds, eclasses, licenses, profiles etc. in a single commit. However,
+ do not split relevant or interdependent changes within a single package.
+ </li>
+ <li>
+ Avoid creating commits introducing a temporary breakage. Unless impossible,
+ add packages in dependency install order. Add licenses before the packages
+ needing them. Commit <c>package.mask</c> and other profile changes before
+ ebuilds relying on them. Usually it is also acceptable to include those
+ changes along with the commit adding the package.
+ </li>
</ol>
<p>
@@ -220,13 +224,15 @@ appropriately:
</p>
<ul>
-<li><c>${CATEGORY}/${PN}:</c> Single Package (Note that <c>repoman commit</c>
-and <c>pkgdev commit</c> will automatically insert 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>
+ <li>
+ <c>${CATEGORY}/${PN}:</c> Single Package (Note that <c>repoman commit</c>
+ and <c>pkgdev commit</c> will automatically insert 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>
<p>
@@ -266,24 +272,31 @@ are optionally used in Gentoo:
</p>
<ul>
-<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
-<c>sys-apps/portage</c> 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>
+ <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
+ <c>sys-apps/portage</c> 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>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2021-09-27 10:20 Ulrich Müller
0 siblings, 0 replies; 11+ messages in thread
From: Ulrich Müller @ 2021-09-27 10:20 UTC (permalink / raw
To: gentoo-commits
commit: b541292297e709a13bcd90ce6ba5c61d9ba5eed7
Author: Joonas Niilola <juippis <AT> gentoo <DOT> org>
AuthorDate: Tue Sep 21 12:55:24 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Sep 26 09:03:52 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b5412922
ebuild-maintenance/git: link to general-concepts/copyright-policy
Signed-off-by: Joonas Niilola <juippis <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 0cad9bf..cf8d6ba 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -145,10 +145,9 @@ manually verify all packages affected by the commit using <c>repoman full</c> or
<c>pkgcheck scan --commits</c>. When using <c>repoman</c>, it won't be aware of
staged changes, so ensure that all files are included in the commit.
Also, when using <c>git</c> manually, you must perform a manual sign-off to the
-<uri link="https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin">
-Certificate of Origin</uri> using the <c>-s</c> or <c>--signoff</c> option
-with your git commit commands. Make sure you have read and understand the
-actual Certificate.
+<uri link="::general-concepts/copyright-policy/#Certificate of origin"/> using
+the <c>-s </c> or <c>--signoff</c> option with your git commit commands. Make
+sure you have read and understand the actual certificate.
</p>
</body>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2022-11-22 4:17 Sam James
0 siblings, 0 replies; 11+ messages in thread
From: Sam James @ 2022-11-22 4:17 UTC (permalink / raw
To: gentoo-commits
commit: 8db9349ee61829e0f17a98619989f94238cafabb
Author: Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Mon Nov 21 00:02:37 2022 +0000
Commit: Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Tue Nov 22 04:17:44 2022 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8db9349e
ebuild-maintenance/git: update grafted repo URL
Signed-off-by: Sam James <sam <AT> gentoo.org>
Closes: https://github.com/gentoo/devmanual/pull/306
Signed-off-by: Sam James <sam <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 411e406..8cdabde 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -90,9 +90,9 @@ graft it into the repository:
</p>
<pre>
-git remote add history https://anongit.gentoo.org/git/repo/gentoo/historical.git/
+git remote add history https://anongit.gentoo.org/git/archive/repo/gentoo-2.git
git fetch history
-git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d history/master
+git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d cvs-final-2015-08-08
</pre>
<p>
^ permalink raw reply related [flat|nested] 11+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/
@ 2024-04-13 19:42 Ulrich Müller
0 siblings, 0 replies; 11+ messages in thread
From: Ulrich Müller @ 2024-04-13 19:42 UTC (permalink / raw
To: gentoo-commits
commit: 4bdda4a2af6af15850924e1c4874aba0266a694d
Author: Volkmar W. Pogatzki <gentoo <AT> pogatzki <DOT> net>
AuthorDate: Thu Feb 29 08:50:58 2024 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sat Apr 13 19:41:19 2024 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4bdda4a2
ebuild-maintenance/git: drop repoman from commit message
Signed-off-by: Volkmar W. Pogatzki <gentoo <AT> pogatzki.net>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 6 ------
1 file changed, 6 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 8bef553..2f3fcb3 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -283,12 +283,6 @@ are optionally used in Gentoo:
referenced, it will be closed (as fixed) automatically with reference
to the commit.
</li>
- <li>
- <c>Package-Manager:</c> Used by repoman to indicate Portage version
- </li>
- <li>
- <c>RepoMan-Options:</c> Used by repoman to indicate repoman options
- </li>
</ul>
<p>
^ permalink raw reply related [flat|nested] 11+ messages in thread
end of thread, other threads:[~2024-04-13 19:42 UTC | newest]
Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-02-23 8:29 [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/git/ Ulrich Müller
-- strict thread matches above, loose matches on Subject: below --
2024-04-13 19:42 Ulrich Müller
2022-11-22 4:17 Sam James
2021-09-27 10:20 Ulrich Müller
2021-03-30 16:10 Ulrich Müller
2021-03-30 16:10 Ulrich Müller
2020-01-14 20:36 Göktürk Yüksek
2019-10-29 20:49 Göktürk Yüksek
2018-01-03 4:51 Göktürk Yüksek
2018-01-03 4:51 Göktürk Yüksek
2018-01-03 4:51 Göktürk Yüksek
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox