Gentoo Archives: gentoo-dev

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