Gentoo Archives: gentoo-dev

From: Gokturk Yuksek <gokturk@××××××××××.edu>
To: devmanual@g.o
Cc: gentoo-dev@l.g.o
Subject: [gentoo-dev] [PATCH v2 09/19] ebuild-maintenance: rewrite the subsection on commit policy for git #558642
Date: Sun, 24 Jan 2016 08:50:47
Message-Id: 1453625173-9505-10-git-send-email-gokturk@binghamton.edu
In Reply to: [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration by Gokturk Yuksek
1 Remove the mention of updating the ChangeLog.
2 Remove the mention of file conflicts during commit as CVS keeps track of
3 files whereas git keeps track of changesets.
4
5 Add a note regarding commit atomicity: Git commits are always atomic, so
6 combining package.mask/license changes with ebuild changes in the same
7 commit does not violate atomicity. However, there is no way to accomplish
8 this using repoman commit.
9
10 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
11 Signed-off-by: Gokturk Yuksek <gokturk@××××××××××.edu>
12 ---
13 ebuild-maintenance/text.xml | 15 +++++++++------
14 1 file changed, 9 insertions(+), 6 deletions(-)
15
16 diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
17 index 10709ea..2d46749 100644
18 --- a/ebuild-maintenance/text.xml
19 +++ b/ebuild-maintenance/text.xml
20 @@ -96,7 +96,7 @@ work on those architectures.
21 </subsection>
22
23 <subsection>
24 -<title>CVS Commit Policy</title>
25 +<title>Git Commit Policy</title>
26 <body>
27
28 <ul>
29 @@ -105,15 +105,18 @@ work on those architectures.
30 <li>Always test that <path>package.mask</path> is okay by doing
31 <c>emerge --pretend mypkg</c> before you commit and check
32 that it doesn't contain any conflicts.</li>
33 -<li>Always update the <path>ChangeLog</path> before you commit.</li>
34 -<li>Always commit the updated <path>package.mask</path> before
35 -the updated package, in case conflicts occur while you commit
36 -<path>package.mask</path>.</li>
37 +<li>Always commit the updated <path>package.mask</path> before
38 +the updated package.</li>
39 <li>Always do atomic commits; if you commit a package with a new license,
40 or that is masked, then first commit the revised <path>package.mask</path> and/or license,
41 then commit the ebuild, <path>ChangeLog</path>, patches
42 and <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> all in <b>one</b> go
43 -to avoid breaking users' installations.</li>
44 +.</li>
45 +<note> Although the set of changes in a single git commit is atomic, and
46 +combining <path>package.mask</path>/license changes with ebuild changes in a
47 +single commit wouldn't break atomicity, it is not currently possible to do so
48 +using <c>repoman commit</c>.</note>
49 +<!-- See: https://bugs.gentoo.org/show_bug.cgi?id=390651 -->
50 </ul>
51
52 </body>
53 --
54 2.4.10