[gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Hi,

This is the third iteration of the patch series that attempts to
update the devmanual for the git migration.

The updates included in the third revision are:
- Added a new subsection called "Git Commit Message Format" based on
  the commit message format included in the Gentoo Git Workflow wiki
  and the feedback provided on this mailing list.
- Based on the discussion wrt how well git deals with compressed
  patches, I've decided to remove "because git does not play well with
  binary files".  It's a policy we have been following for years
  irrespective of how git deals with them.
- Rewrote the subsection on "Removing a package" so it does not use
  'git commit -m'. Rewrote the example and added the corresponding
  commit message as an example.
- The subsection "User-submitted Ebuilds" is modified to mention the
  use of git style tags in commit messages and a reference to the
  commit message format policy section has been added.

You can review the changes on Github for your own convenience:
https://github.com/gktrk/devmanual.gentoo.org/compare/master...gktrk:devmanual-git-migration-v3

If you want to see the diff between v2 and v3, you can clone the
Github repo and check the diff between the branches
"devmanual-git-migration-v2" and "devmanual-git-migration-v3".

The HTML version of the devmanual with the proposed changes can be found at:
http://devmanual.qui-gon.org/

Gokturk Yuksek (19):
  general-concepts/manifest: drop the use of "CVS keyword expansion"
    #558642
  general-concepts/mirrors: substitute "CVS" with "the git tree" #558642
  general-concepts/tree: substitute "CVS" with "git" #558642
  general-concepts/tree: replace the mention of ChangeLog #558642
  ebuild-writing/misc-files: replace the code for cvs commit with git
    #558642
  ebuild-writing/user-submitted: do not put user information in
    ChangeLog #558642
  appendices/editor-configuration/emacs: remove the CVS related setting
    #558642
  ebuild-maintenance: rewrite the text on adding binary files to the
    tree #558642
  ebuild-maintenance: rewrite the subsection on commit policy for git
    #558642
  ebuild-maintenance: rewrite the subsection on upgrading ebuilds for
    git #558642
  ebuild-maintenance: rewrite the subsection on moving ebuilds for git
    #558642
  ebuild-maintenance: rewrite the subsection on removing ebuilds for git
    #558642
  ebuild-maintenance: rewrite the subsection on removing packages for
    git #558642
  ebuild-maintenance: replace "cvs commit" with "git commit" #558642
  general-concepts/git-to-rsync/diagram: update the description for git
    #558642
  general-concepts/git-to-rsync/diagram: update the description for git
    #558642
  general-concepts/tree: remove the reference to the ChangeLog #485314
  ebuid-maintenance: add a new section called "Git Commit Message
    Format" #558642
  ebuild-writing/user-submitted: mention git style tags in commit
    messages #558642

Michael Orlitzky (2):
  ebuild-writing/misc-files: remove ChangeLog section #485314
  tools-reference: remove the echangelog page #485314

 appendices/editor-configuration/emacs/text.xml |   4 +-
 ebuild-maintenance/text.xml                    | 281 +++++++++++++++++++------
 ebuild-writing/common-mistakes/text.xml        |   2 +-
 ebuild-writing/misc-files/changelog/text.xml   | 111 ----------
 ebuild-writing/misc-files/metadata/text.xml    |  16 +-
 ebuild-writing/misc-files/text.xml             |   1 -
 ebuild-writing/user-submitted/text.xml         |  14 +-
 general-concepts/git-to-rsync/diagram.svg      |   2 +-
 general-concepts/manifest/text.xml             |   4 +-
 general-concepts/mirrors/diagram.svg           |   2 +-
 general-concepts/mirrors/text.xml              |   2 +-
 general-concepts/tree/text.xml                 |   5 +-
 tools-reference/echangelog/text.xml            |  32 ---
 tools-reference/text.xml                       |   1 -
 14 files changed, 247 insertions(+), 230 deletions(-)
 delete mode 100644 ebuild-writing/misc-files/changelog/text.xml
 delete mode 100644 tools-reference/echangelog/text.xml

-- 
2.4.10

[gentoo-dev] [PATCH v3 01/21] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

With the git migration no CVS keyword expansions are happening. However,
Manifest file may still need to be regenerated.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/manifest/text.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/general-concepts/manifest/text.xml b/general-concepts/manifest/text.xml
index 27ebdef..12961da 100644
--- a/general-concepts/manifest/text.xml
+++ b/general-concepts/manifest/text.xml
@@ -18,8 +18,8 @@ The <c>Manifest</c> may also be digitally signed.
 
 <p>
 To generate the <c>Manifest</c>, use <c>ebuild foo.ebuild manifest</c>. When
-committing, the <c>Manifest</c> file must be regenerated to handle any CVS keyword
-expansion changes <d/> <c>repoman</c> will do this automatically.
+committing, the <c>Manifest</c> file must be regenerated to handle any
+changes <d/> <c>repoman</c> will do this automatically.
 </p>
 </body>
 </section>
-- 
2.4.10

[gentoo-dev] [PATCH v3 02/21] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/mirrors/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/general-concepts/mirrors/text.xml b/general-concepts/mirrors/text.xml
index e860988..6e3386a 100644
--- a/general-concepts/mirrors/text.xml
+++ b/general-concepts/mirrors/text.xml
@@ -55,7 +55,7 @@ On rare occasions you may need to replace a file that is already mirrored.  In t
 follows:
 <ol>
   <li>Put a copy of the new distfile on dev.gentoo.org into /space/distfiles-local</li>
-  <li>commit the new manifest to CVS</li>
+  <li>commit the new manifest to the git tree</li>
   <li>wait</li>
 </ol>
 After a few hours a cron job on dev.gentoo.org will fetch the file and replace the version on the
-- 
2.4.10

[gentoo-dev] [PATCH v3 03/21] general-concepts/tree: substitute "CVS" with "git" #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/tree/text.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml
index 022a1ea..6f59f09 100644
--- a/general-concepts/tree/text.xml
+++ b/general-concepts/tree/text.xml
@@ -59,11 +59,11 @@ The basic layout of the portage tree is as follows:
   <li>Scripts directory, <c>scripts/</c></li>
   <li>
   Distfiles directory, <c>distfiles/</c>. This is not included in the main
-  CVS tree, but it will be found on most user systems.
+  git tree, but it will be found on most user systems.
   </li>
   <li>
   Packages directory, <c>packages</c>. Again, this is found on user systems but not
-  in the main CVS tree.
+  in the main git tree.
   </li>
 </ul>
 </body>
-- 
2.4.10

[gentoo-dev] [PATCH v3 04/21] general-concepts/tree: replace the mention of ChangeLog #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Package updates do not require changing of the ChangeLog file. Package
updates by users that do not mention what has changed is still
considered a common mistake however.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 ebuild-writing/common-mistakes/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 1718d55..1716e5d 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -468,7 +468,7 @@ of the application, if any exists.
 </body>
 </subsection>
 <subsection>
-<title>Package updates without changing the ChangeLog</title>
+<title>Package updates without explaining what has changed</title>
 <body>
 
 <p>
-- 
2.4.10

[gentoo-dev] [PATCH v3 05/21] ebuild-writing/misc-files: replace the code for cvs commit with git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Replace "cvs commit" with the equivalent "git add && git commit" version.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 ebuild-writing/misc-files/metadata/text.xml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index e506b1c..2de3cf5 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -532,7 +532,21 @@ is currently:
 <pre>
 xmllint --noout --valid metadata.xml
 glep31check metadata.xml
-cvs commit -m "Adding category metadata.xml for my-category" metadata.xml
+git add metadata.xml
+git commit --gpg-sign
+</pre>
+
+<p>
+The commit message should be formatted properly.
+A sample commit is shown below:
+</p>
+
+<pre>
+commit db359439bcd52f5a7f20d2332ab62feb16657504
+Author: Alexis Ballier &lt;aballier@gentoo.org&gt;
+Date:   Tue Sep 22 10:47:49 2015 +0200
+
+  dev-ros: Add metadata.xml for the category.
 </pre>
 
 </body>
-- 
2.4.10

Re: [gentoo-dev] [PATCH v3 05/21] ebuild-writing/misc-files: replace the code for cvs commit with git #558642

[Brian Dolbec]

On Wed,  3 Feb 2016 19:57:33 -0500
gokturk@binghamton.edu wrote:

> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
> Replace "cvs commit" with the equivalent "git add && git commit"
> version.
> 
> Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
> Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
> ---
>  ebuild-writing/misc-files/metadata/text.xml | 16 +++++++++++++++-
>  1 file changed, 15 insertions(+), 1 deletion(-)
> 
> diff --git a/ebuild-writing/misc-files/metadata/text.xml
> b/ebuild-writing/misc-files/metadata/text.xml index e506b1c..2de3cf5
> 100644 --- a/ebuild-writing/misc-files/metadata/text.xml
> +++ b/ebuild-writing/misc-files/metadata/text.xml
> @@ -532,7 +532,21 @@ is currently:
>  <pre>
>  xmllint --noout --valid metadata.xml
>  glep31check metadata.xml
> -cvs commit -m "Adding category metadata.xml for my-category"
> metadata.xml +git add metadata.xml
> +git commit --gpg-sign
>

This should be repoman commit still, not git commit

 +</pre>
> +
> +<p>
> +The commit message should be formatted properly.
> +A sample commit is shown below:
> +</p>
> +
> +<pre>
> +commit db359439bcd52f5a7f20d2332ab62feb16657504
> +Author: Alexis Ballier &lt;aballier@gentoo.org&gt;
> +Date:   Tue Sep 22 10:47:49 2015 +0200
> +
> +  dev-ros: Add metadata.xml for the category.
>  </pre>
>  
>  </body>



-- 
Brian Dolbec <dolsen>

Re: [gentoo-dev] [PATCH v3 05/21] ebuild-writing/misc-files: replace the code for cvs commit with git #558642

[Ulrich Mueller]

[-- Attachment #1: Type: text/plain, Size: 896 bytes --]

>>>>> On Wed, 3 Feb 2016, Brian Dolbec wrote:

>> --- a/ebuild-writing/misc-files/metadata/text.xml
>> +++ b/ebuild-writing/misc-files/metadata/text.xml
>> @@ -532,7 +532,21 @@ is currently:
>> <pre>
>> xmllint --noout --valid metadata.xml
>> glep31check metadata.xml
>> -cvs commit -m "Adding category metadata.xml for my-category"
>> metadata.xml +git add metadata.xml
>> +git commit --gpg-sign
>> 

> This should be repoman commit still, not git commit

This is about the last section, namely adding category metadata.
IMHO using "git commit" is perfectly fine here. ("repoman commit"
would do much more, e.g. regenerate Manifests in all package
subdirectories, which may not be wanted.)

However, I wonder about the "glep31check" line above, since I have
never heard of that. Also "e-file glep31check" returns no hits. Maybe
we shouldn't recommend a tool that isn't even in the tree?

Ulrich

[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]

Re: [gentoo-dev] [PATCH v3 05/21] ebuild-writing/misc-files: replace the code for cvs commit with git #558642

[Göktürk Yüksek]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512



Ulrich Mueller:
>>>>>> On Wed, 3 Feb 2016, Brian Dolbec wrote:
> 
>>> --- a/ebuild-writing/misc-files/metadata/text.xml +++ 
>>> b/ebuild-writing/misc-files/metadata/text.xml @@ -532,7
>>> +532,21 @@ is currently: <pre> xmllint --noout --valid
>>> metadata.xml glep31check metadata.xml -cvs commit -m "Adding
>>> category metadata.xml for my-category" metadata.xml +git add 
>>> metadata.xml +git commit --gpg-sign
>>> 
> 
>> This should be repoman commit still, not git commit
> 
> This is about the last section, namely adding category metadata. 
> IMHO using "git commit" is perfectly fine here. ("repoman commit" 
> would do much more, e.g. regenerate Manifests in all package 
> subdirectories, which may not be wanted.)
> 
> However, I wonder about the "glep31check" line above, since I have
>  never heard of that. Also "e-file glep31check" returns no hits. 
> Maybe we shouldn't recommend a tool that isn't even in the tree?
> 
I've already created a bug for this 3 weeks ago:
https://bugs.gentoo.org/show_bug.cgi?id=572156

The source used to be hosted here:
http://dev.gentoo.org/~ciaranm/toys/glep31check-0.3.3.tar.bz2

Should we get rid of it?

> Ulrich
> 

- --
gokturk
-----BEGIN PGP SIGNATURE-----

iQEcBAEBCgAGBQJWtEZyAAoJEIT4AuXAiM4zQ3cH/i1cpHRjzcywCFPJpgm4pqk2
q08aezx37k546aLL5vgHR7raY6AGwN9/fWKhGtiwESg4KSwM32fVUO57NO2XiJcM
cQ9iSAczorD3kdX+t4dnSKCsgdD3ZuOWmCN7KZqpTH4FIKuFTzlbWIbaJip28TQ8
7Vj1FnfN+bLQqcU7v3VnxvbMGlNP1kemQLFgpdr95ippWqznzG8ztWuRwWQO99Th
w76xe0XWl69eKHc3NGHFGEkRjI7XahDl+tLxSusgZCXKofADj/s1UuTJ7XuPQTem
iXLYPmzxGyeSQ7Xr7bSlYtvBCDdQYq9MKJHDIqswJ3fnt0qPwxLemcR1AvRLeYg=
=Xx//
-----END PGP SIGNATURE-----

[gentoo-dev] [PATCH v3 06/21] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

ChangeLog files are auto-generated by infra post git-migration.
For user-submitted ebuilds, include the user information in the commit
message instead. Mention that user submitted git patches and pull
requests preserve the authorship information by default.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 ebuild-writing/user-submitted/text.xml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml
index ef80c0d..a148042 100644
--- a/ebuild-writing/user-submitted/text.xml
+++ b/ebuild-writing/user-submitted/text.xml
@@ -16,14 +16,16 @@ the ebuild meets all Gentoo Linux development standards.
 The user-submitted ebuild must not contain custom headers like this:
 </p>
 
-<pre caption="A custom header that should be transferred to the ChangeLog">
+<pre caption="A custom header that should be included in the commit message instead">
 # Ebuild updated by: me &lt;me@example.com&gt;
 </pre>
 
 <p>
-Such information should be added to the <c>ChangeLog</c> instead.
-The first <c>ChangeLog</c> entry should always credit the user who
-submitted the ebuild, with their full name and e-mail address.
+Such information should be included in the git commit message instead.
+Note that ebuilds received in the form of git patches or pull requests
+will have the user as the commit author by default, in which case
+including the user information in the commit message explicitly
+may not be necessary.
 </p>
 
 <p>
-- 
2.4.10

[gentoo-dev] [PATCH v3 07/21] appendices/editor-configuration/emacs: remove the CVS related setting #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Setting vc-cvs-stay-local to nil causes VC to query the remote repository.
Git is a distributed VCS. As such no equivalent command exists for git.
Remove the CVS related setting.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 appendices/editor-configuration/emacs/text.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/appendices/editor-configuration/emacs/text.xml b/appendices/editor-configuration/emacs/text.xml
index 55fade0..0a5e38d 100644
--- a/appendices/editor-configuration/emacs/text.xml
+++ b/appendices/editor-configuration/emacs/text.xml
@@ -47,8 +47,8 @@ automatically check for the existence of it and ask you to add one.
 
 <p>
 Other useful settings can be disabled backup files
-(by <c>(setq make-backup-files nil)</c> and
-<c>(setq vc-cvs-stay-local nil)</c>), so you don't clutter CVS
+(by <c>(setq make-backup-files nil)</c>, so you don't clutter the git
+repository
 directories and confuse repoman with it (by adding unnecessary entries
 into a Manifest file e.g.). Emacs can even contact the outside world
 by using the X servers clipboard abilities when yanking, which is
-- 
2.4.10

[gentoo-dev] [PATCH v3 08/21] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

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@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>
-- 
2.4.10

[gentoo-dev] [PATCH v3 09/21] ebuild-maintenance: rewrite the subsection on commit policy for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

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@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>
-- 
2.4.10

[gentoo-dev] [PATCH v3 10/21] ebuild-maintenance: rewrite the subsection on upgrading ebuilds for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

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@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>
 
-- 
2.4.10

[gentoo-dev] [PATCH v3 11/21] ebuild-maintenance: rewrite the subsection on moving ebuilds for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

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@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 &lt;amadio@gentoo.org&gt;
+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>
 
-- 
2.4.10

[gentoo-dev] [PATCH v3 12/21] ebuild-maintenance: rewrite the subsection on removing ebuilds for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Substitute the mentions of CVS with git.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@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>
-- 
2.4.10

[gentoo-dev] [PATCH v3 13/21] ebuild-maintenance: rewrite the subsection on removing packages for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

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@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 &lt;kensington@gentoo.org&gt;
+Date:   Fri Jan 29 07:11:01 2016 +1100
+
+  dev-util/pmk: remove last-rited package
+
+  Gentoo-bug: 541522
+</pre>
 
 </body>
 </section>
-- 
2.4.10

[gentoo-dev] [PATCH v3 14/21] ebuild-maintenance: replace "cvs commit" with "git commit" #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@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>
 
-- 
2.4.10

[gentoo-dev] [PATCH v3 15/21] general-concepts/git-to-rsync/diagram: update the description for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/git-to-rsync/diagram.svg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/general-concepts/git-to-rsync/diagram.svg b/general-concepts/git-to-rsync/diagram.svg
index 8cf7414..2ee9608 100644
--- a/general-concepts/git-to-rsync/diagram.svg
+++ b/general-concepts/git-to-rsync/diagram.svg
@@ -2,7 +2,7 @@
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
     "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 <svg width="700" height="250" xmlns="http://www.w3.org/2000/svg" version="1.1">
-    <desc>CVS to RSYNC Propagation</desc>
+    <desc>Git to RSYNC Propagation</desc>
 
     <rect x="-10" y="-10" width="1000" height="1000" fill="#eeeeee" id="background" />
 
-- 
2.4.10

[gentoo-dev] [PATCH v3 16/21] general-concepts/git-to-rsync/diagram: update the description for git #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/mirrors/diagram.svg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/general-concepts/mirrors/diagram.svg b/general-concepts/mirrors/diagram.svg
index 0af1f1c..b807e5a 100644
--- a/general-concepts/mirrors/diagram.svg
+++ b/general-concepts/mirrors/diagram.svg
@@ -52,7 +52,7 @@
   <defs
      id="defs1680" />
   <desc
-     id="desc1548">CVS to RSYNC Propagation</desc>
+     id="desc1548">Git to RSYNC Propagation</desc>
   <rect
      y="0.24284256"
      x="-2.0556145"
-- 
2.4.10

[gentoo-dev] [PATCH v3 17/21] ebuild-writing/misc-files: remove ChangeLog section #485314

[gokturk]

From: Michael Orlitzky <mjo@gentoo.org>

The ChangeLog section under misc-files is misleading now that our main
repository has been switched to git (and we no longer have
ChangeLogs). Remove the ebuild-writing/misc-files/changelog page.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=485314
---
 ebuild-writing/misc-files/changelog/text.xml | 111 ---------------------------
 ebuild-writing/misc-files/text.xml           |   1 -
 2 files changed, 112 deletions(-)
 delete mode 100644 ebuild-writing/misc-files/changelog/text.xml

diff --git a/ebuild-writing/misc-files/changelog/text.xml b/ebuild-writing/misc-files/changelog/text.xml
deleted file mode 100644
index ff68e11..0000000
--- a/ebuild-writing/misc-files/changelog/text.xml
+++ /dev/null
@@ -1,111 +0,0 @@
-<?xml version="1.0"?>
-<guide self="ebuild-writing/misc-files/changelog/">
-<chapter>
-<title>ChangeLog</title>
-
-<body>
-<p>
-The <c>ChangeLog</c> must be updated with each commit. The
-<uri link="::tools-reference/echangelog/">echangelog tool</uri> should be used to create <c>ChangeLog</c> entries;
-the format of a <c>ChangeLog</c> is now defined as "whatever
-<c>echangelog</c> creates".
-</p>
-
-<p>
-You should include references to any relevant bugs. The standard
-format for doing this is via the phrase <c>bug #20600</c> — this
-format (with the hash sign included) is recognised via
-<uri link="https://packages.gentoo.org">packages.gentoo.org</uri> and
-similar tools. When including user-submitted ebuilds or patches, you
-should credit the user with their full name and email address (or
-whatever they use to identify themselves on bugzilla <d/> some users
-prefer to be known only by a nickname).
-</p>
-
-<p>
-If you are changing keywords, make sure you clearly state what
-keywords you add or remove. "Marked stable" is a nuisance for
-architecture teams, even if there was only one keyword in the ebuild
-at the time. "Stable on all archs" isn't generally any better (and
-should you really be stabling on all archs?) — do you mean "all", or
-"all the ones that are currently keyworded"? A list like "x86 sparc
-mips" is much more useful.
-</p>
-
-<p>
-A typical <c>ChangeLog</c> snippet might look like the following:
-</p>
-
-<pre>
-    *vim-6.3.068 (25 Mar 2005)
-
-      25 Mar 2005; Ciaran McCreesh &lt;ciaranm@gentoo.org&gt; +vim-6.3.068.ebuild:
-      New release. Fixes bug #79981, bug #81289, bug #83383, bug #83416, bug
-      #83565, bug #85758, upstream patches up to 6.3.068.
-
-      22 Mar 2005; Aron Griffis &lt;agriffis@gentoo.org&gt; vim-6.3-r4.ebuild:
-      Stable on alpha
-</pre>
-
-<note>
-If a <c>ChangeLog</c> file is not present in your current working directory,
-then you should write a <c>ChangeLog</c> entry in the parent's directory
-<c>ChangeLog</c> file.
-</note>
-
-<section>
-<title>Writing correct ChangeLog messages</title>
-<body>
-<note>
-It is <b>very</b> important that your <c>cvs commit</c> messages are
-also informative to aid the QA team or architecture teams as well as
-other developers if they are trying to troubleshoot issues which are
-known to not have occured in previous versions of ebuilds, for
-example. If your ChangeLog message is concise there is usually nothing
-wrong with using it as the <c>cvs commit</c> message.
-</note>
-
-<p>
-Your message should explain what specifically you changed and, if
-relevant, why. You don't need to write an essay or even a complete
-sentence (<c>ChangeLog</c> messages, however, are required to be in
-'proper' English so no <c>fixed that bug kthx Bob</c> messages —
-please do use punctuation), so long as it is easily understandable and
-(preferably) greppable. Bad and good examples, all of which are based
-upon real messages:
-</p>
-
-<ul>
-  <li><b>BAD:</b> Changed keywords</li>
-  <li><e>GOOD:</e> Added ~x86 keyword</li>
-</ul>
-
-<ul>
-  <li><b>BAD:</b> Stable</li>
-  <li><e>GOOD:</e> Stable on x86, sparc, mips</li>
-</ul>
-
-<ul>
-  <li><b>BAD:</b> Fix stuff</li>
-  <li><e>GOOD:</e> Fix USE=foo logic error</li>
-</ul>
-
-<ul>
-  <li><b>BAD:</b> .</li>
-  <li><e>GOOD:</e> Purge old ebuilds</li>
-</ul>
-
-<ul>
-  <li>
-    <b>BAD:</b> Who the fuck reads this anyway? (<b>Editor's note</b>:
-    No, seriously, this is a genuine example. Do <e>not</e> do
-    this...)
-  </li>
-  <li><e>GOOD:</e> Version bump to 0.5.1.</li>
-</ul>
-
-</body>
-</section>
-</body>
-</chapter>
-</guide>
diff --git a/ebuild-writing/misc-files/text.xml b/ebuild-writing/misc-files/text.xml
index 31f1421..416070b 100644
--- a/ebuild-writing/misc-files/text.xml
+++ b/ebuild-writing/misc-files/text.xml
@@ -18,6 +18,5 @@ This section contains some notes on various miscellaneous files.
 </chapter>
 
 <include href="metadata/"/>
-<include href="changelog/"/>
 <include href="patches/"/>
 </guide>
-- 
2.4.10

[gentoo-dev] [PATCH v3 18/21] tools-reference: remove the echangelog page #485314

[gokturk]

From: Michael Orlitzky <mjo@gentoo.org>

Since the switch to git, developers should never need to use
echangelog. Remove its page from the tools-reference section.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=485314
---
 tools-reference/echangelog/text.xml | 32 --------------------------------
 tools-reference/text.xml            |  1 -
 2 files changed, 33 deletions(-)
 delete mode 100644 tools-reference/echangelog/text.xml

diff --git a/tools-reference/echangelog/text.xml b/tools-reference/echangelog/text.xml
deleted file mode 100644
index 567dad9..0000000
--- a/tools-reference/echangelog/text.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0"?>
-<guide self="tools-reference/echangelog/">
-<chapter>
-<title><c>echangelog</c> -- ChangeLog Generation</title>
-<body>
-
-<p>
-The <c>echangelog</c> tool should be used to generate <uri link="::ebuild-writing/misc-files/changelog/">ChangeLog</uri>
-entries. This tool uses the <c>ECHANGELOG_USER</c> environment
-variable, which should be set in the format "Your Name
-&lt;user@gentoo.org&gt;". The changelog message should be passed to
-<c>echangelog</c> on the commandline, or otherwise <c>echangelog</c>
-will open an editor for you to type your message.
-</p>
-
-<p>
-<c>echangelog</c> should be called <e>after</e> any adds, removes or
-updates have been made.
-</p>
-
-<p>
-See echangelog-1 for details.
-</p>
-
-<note>
-The <c>echangelog</c> tool is considered deprecated as <c>repoman commit -m "[your message here]"</c>
- will create a ChangeLog entry automatically when used for commits in the portage tree.
-</note>
-
-</body>
-</chapter>
-</guide>
diff --git a/tools-reference/text.xml b/tools-reference/text.xml
index a4cadf8..9e0f6bc 100644
--- a/tools-reference/text.xml
+++ b/tools-reference/text.xml
@@ -23,7 +23,6 @@ ebuilds.
 <include href="cat/"/>
 <include href="cut/"/>
 <include href="diff-and-patch/"/>
-<include href="echangelog/"/>
 <include href="echo/"/>
 <include href="ekeyword/"/>
 <include href="false-and-true/"/>
-- 
2.4.10

[gentoo-dev] [PATCH v3 19/21] general-concepts/tree: remove the reference to the ChangeLog #485314

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=485314
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 general-concepts/tree/text.xml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/general-concepts/tree/text.xml b/general-concepts/tree/text.xml
index 6f59f09..877b8f4 100644
--- a/general-concepts/tree/text.xml
+++ b/general-concepts/tree/text.xml
@@ -17,7 +17,6 @@ The basic layout of the portage tree is as follows:
     Package directories for example <c>app-editors/vim</c>
     <ul>
       <li>Package metadata, for example <c>app-editors/vim/metadata.xml</c></li>
-      <li>Package changelog, for example <c>app-editors/vim/ChangeLog</c></li>
       <li>Package Manifest, for example <c>app-editors/vim/Manifest</c></li>
       <li>
       Ebuilds, for example <c>app-editors/vim/vim-6.3.068.ebuild</c>,
-- 
2.4.10

[gentoo-dev] [PATCH v3 20/21] ebuid-maintenance: add a new section called "Git Commit Message Format" #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

This section includes the content from the "Commit message format"
subsection on Gentoo git workflow wiki page, combines it with some of
the information that was part of the old ChangeLog section in
devmanual and expands on those based on the feedback from the developers
on the gentoo-dev@g.o mailing list.

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Reviewed-by: NP-Hardass <np-hardass@gentoo.org>
Signed-off-by: Gokturk Yuksek <gokturk@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>
 
-- 
2.4.10

Re: [gentoo-dev] [PATCH v3 20/21] ebuid-maintenance: add a new section called "Git Commit Message Format" #558642

[Ulrich Mueller]

[-- Attachment #1: Type: text/plain, Size: 1050 bytes --]

>>>>> On Wed, 3 Feb 2016, gokturk  wrote:

> This section includes the content from the "Commit message format"
> subsection on Gentoo git workflow wiki page, combines it with some
> of the information that was part of the old ChangeLog section in
> devmanual and expands on those based on the feedback from the
> developers on the gentoo-dev@g.o mailing list.

Great work!

One minor issue, though: Please mention the license and reference
the actual URL of the wiki page in the commit message for proper
attribution under CC-BY-SA-3.0. For example, like this:

   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.

Also, don't say "content" [1].

I guess we'll finally have to bump the license of the devmanual from
CC-BY-SA-2.0 to 3.0 before including this. There's already a bug open
for that (#558732).

Ulrich

[1] http://www.gnu.org/philosophy/words-to-avoid.en.html#Content

[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]

[gentoo-dev] [PATCH v3 21/21] ebuild-writing/user-submitted: mention git style tags in commit messages #558642

[gokturk]

From: Gokturk Yuksek <gokturk@binghamton.edu>

Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>
---
 ebuild-writing/user-submitted/text.xml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml
index a148042..68c88f0 100644
--- a/ebuild-writing/user-submitted/text.xml
+++ b/ebuild-writing/user-submitted/text.xml
@@ -22,6 +22,10 @@ The user-submitted ebuild must not contain custom headers like this:
 
 <p>
 Such information should be included in the git commit message instead.
+The use of tags such as <c>Suggested-By:</c> or <c>Reported-By:</c>in
+the commit message, as explained in the
+<uri link="::ebuild-maintenance#git-commit-message-format">commit
+message format section</uri>, is highly encouraged.
 Note that ebuilds received in the form of git patches or pull requests
 will have the user as the commit author by default, in which case
 including the user information in the commit message explicitly
-- 
2.4.10

Re: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[Daniel Campbell]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/03/2016 04:57 PM, gokturk@binghamton.edu wrote:
> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
> Hi,
> 
> This is the third iteration of the patch series that attempts to 
> update the devmanual for the git migration.
> 
> The updates included in the third revision are: - Added a new
> subsection called "Git Commit Message Format" based on the commit
> message format included in the Gentoo Git Workflow wiki and the
> feedback provided on this mailing list. - Based on the discussion
> wrt how well git deals with compressed patches, I've decided to
> remove "because git does not play well with binary files".  It's a
> policy we have been following for years irrespective of how git
> deals with them. - Rewrote the subsection on "Removing a package"
> so it does not use 'git commit -m'. Rewrote the example and added
> the corresponding commit message as an example. - The subsection
> "User-submitted Ebuilds" is modified to mention the use of git
> style tags in commit messages and a reference to the commit message
> format policy section has been added.
> 
> You can review the changes on Github for your own convenience: 
> https://github.com/gktrk/devmanual.gentoo.org/compare/master...gktrk:devmanual-git-migration-v3
>
>  If you want to see the diff between v2 and v3, you can clone the 
> Github repo and check the diff between the branches 
> "devmanual-git-migration-v2" and "devmanual-git-migration-v3".
> 
> The HTML version of the devmanual with the proposed changes can be
> found at: http://devmanual.qui-gon.org/
> 
> Gokturk Yuksek (19): general-concepts/manifest: drop the use of
> "CVS keyword expansion" #558642 general-concepts/mirrors:
> substitute "CVS" with "the git tree" #558642 general-concepts/tree:
> substitute "CVS" with "git" #558642 general-concepts/tree: replace
> the mention of ChangeLog #558642 ebuild-writing/misc-files: replace
> the code for cvs commit with git #558642 
> ebuild-writing/user-submitted: do not put user information in 
> ChangeLog #558642 appendices/editor-configuration/emacs: remove the
> CVS related setting #558642 ebuild-maintenance: rewrite the text on
> adding binary files to the tree #558642 ebuild-maintenance: rewrite
> the subsection on commit policy for git #558642 ebuild-maintenance:
> rewrite the subsection on upgrading ebuilds for git #558642 
> ebuild-maintenance: rewrite the subsection on moving ebuilds for
> git #558642 ebuild-maintenance: rewrite the subsection on removing
> ebuilds for git #558642 ebuild-maintenance: rewrite the subsection
> on removing packages for git #558642 ebuild-maintenance: replace
> "cvs commit" with "git commit" #558642 
> general-concepts/git-to-rsync/diagram: update the description for
> git #558642 general-concepts/git-to-rsync/diagram: update the
> description for git #558642 general-concepts/tree: remove the
> reference to the ChangeLog #485314 ebuid-maintenance: add a new
> section called "Git Commit Message Format" #558642 
> ebuild-writing/user-submitted: mention git style tags in commit 
> messages #558642
> 
> Michael Orlitzky (2): ebuild-writing/misc-files: remove ChangeLog
> section #485314 tools-reference: remove the echangelog page
> #485314
> 
> appendices/editor-configuration/emacs/text.xml |   4 +- 
> ebuild-maintenance/text.xml                    | 281
> +++++++++++++++++++------ ebuild-writing/common-mistakes/text.xml
> |   2 +- ebuild-writing/misc-files/changelog/text.xml   | 111
> ---------- ebuild-writing/misc-files/metadata/text.xml    |  16 +- 
> ebuild-writing/misc-files/text.xml             |   1 - 
> ebuild-writing/user-submitted/text.xml         |  14 +- 
> general-concepts/git-to-rsync/diagram.svg      |   2 +- 
> general-concepts/manifest/text.xml             |   4 +- 
> general-concepts/mirrors/diagram.svg           |   2 +- 
> general-concepts/mirrors/text.xml              |   2 +- 
> general-concepts/tree/text.xml                 |   5 +- 
> tools-reference/echangelog/text.xml            |  32 --- 
> tools-reference/text.xml                       |   1 - 14 files
> changed, 247 insertions(+), 230 deletions(-) delete mode 100644
> ebuild-writing/misc-files/changelog/text.xml delete mode 100644
> tools-reference/echangelog/text.xml
> 

This isn't related to what you're doing but I felt it was a good place
to ask:

How are you and other developers creating these series of e-mails? It
seems really handy and I'd like to know what it is, in the event that
I need to do the same.

- -- 
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJWsqUGAAoJEAEkDpRQOeFw1tcQANTfi+BFhZJDk2AY5N1Cy5jW
tMdVsnaFLR/up2MAQx53TPhJ9k4BKIpl9+fFmaY5iFs1KshRtYQ3fNWzs/oO2oby
X1lKWdO8y8QqGPUY9xkiq5LxujfcI+ZcGBhTN1Ir6CZJMLmrxGlytCGqs8b/2beU
sGe4Puzjvly1CwyfROUzlksJpP/+0z+jrJIHmYp2gwPTKnpIuQ5hdx3l6N0kP/hF
diizpptajir3HYDgz6Fdge8HHmlGqD8t62sSnbCyIy9CR28T5lPoK+WNd1s5OFqu
UcNMdKqSKkjN3qrvNl7/nYGSO+VhILgai6y28yQ0FGGMH+a5iXoGkMddkQsfe32Q
Kgwjhd/8DtjsZ/YVjVFSMlA8TYLf0LhPwJqfRmcILkS05sAmmyFCrHVu3gedicsu
w/j3cviDTNoGvWxs3xCj0BWmNqOSFCoVJ/Y+kVT9cFz4SH1VaANHXUz3NCFy0h8i
k/rJF72EpNiMYJvUNc1Mb0ip0P2hQ7uEkP2ZP6etduLWCmTiGqK1iqP/spBoDht1
9aUuCRKyUxSwM1JexcVBHE0UqM/+/KUuCYsh9EhqazO3TTrQip/4gsNfZ2fgy+D5
H+AtEit9zEfq1uPW8ymoDXb6oJQTrCJCabGOenLWLpODp7GOHXhJlsNqCyDZmwi7
lHE2woW+95avbzPwRJ32
=9iT4
-----END PGP SIGNATURE-----

Re: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[NP-Hardass]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/03/2016 08:10 PM, Daniel Campbell wrote:
> On 02/03/2016 04:57 PM, gokturk@binghamton.edu wrote:
>> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
>> Hi,
> 
>> This is the third iteration of the patch series that attempts to
>>  update the devmanual for the git migration.
> 
>> The updates included in the third revision are: - Added a new 
>> subsection called "Git Commit Message Format" based on the
>> commit message format included in the Gentoo Git Workflow wiki
>> and the feedback provided on this mailing list. - Based on the
>> discussion wrt how well git deals with compressed patches, I've
>> decided to remove "because git does not play well with binary
>> files".  It's a policy we have been following for years
>> irrespective of how git deals with them. - Rewrote the subsection
>> on "Removing a package" so it does not use 'git commit -m'.
>> Rewrote the example and added the corresponding commit message as
>> an example. - The subsection "User-submitted Ebuilds" is modified
>> to mention the use of git style tags in commit messages and a
>> reference to the commit message format policy section has been
>> added.
> 
>> You can review the changes on Github for your own convenience: 
>> https://github.com/gktrk/devmanual.gentoo.org/compare/master...gktrk:
devmanual-git-migration-v3
>
>>  If you want to see the diff between v2 and v3, you can clone the
>>  Github repo and check the diff between the branches 
>> "devmanual-git-migration-v2" and "devmanual-git-migration-v3".
> 
>> The HTML version of the devmanual with the proposed changes can
>> be found at: http://devmanual.qui-gon.org/
> 
>> Gokturk Yuksek (19): general-concepts/manifest: drop the use of 
>> "CVS keyword expansion" #558642 general-concepts/mirrors: 
>> substitute "CVS" with "the git tree" #558642
>> general-concepts/tree: substitute "CVS" with "git" #558642
>> general-concepts/tree: replace the mention of ChangeLog #558642
>> ebuild-writing/misc-files: replace the code for cvs commit with
>> git #558642 ebuild-writing/user-submitted: do not put user
>> information in ChangeLog #558642
>> appendices/editor-configuration/emacs: remove the CVS related
>> setting #558642 ebuild-maintenance: rewrite the text on adding
>> binary files to the tree #558642 ebuild-maintenance: rewrite the
>> subsection on commit policy for git #558642 ebuild-maintenance: 
>> rewrite the subsection on upgrading ebuilds for git #558642 
>> ebuild-maintenance: rewrite the subsection on moving ebuilds for 
>> git #558642 ebuild-maintenance: rewrite the subsection on
>> removing ebuilds for git #558642 ebuild-maintenance: rewrite the
>> subsection on removing packages for git #558642
>> ebuild-maintenance: replace "cvs commit" with "git commit"
>> #558642 general-concepts/git-to-rsync/diagram: update the
>> description for git #558642
>> general-concepts/git-to-rsync/diagram: update the description for
>> git #558642 general-concepts/tree: remove the reference to the
>> ChangeLog #485314 ebuid-maintenance: add a new section called
>> "Git Commit Message Format" #558642 
>> ebuild-writing/user-submitted: mention git style tags in commit 
>> messages #558642
> 
>> Michael Orlitzky (2): ebuild-writing/misc-files: remove
>> ChangeLog section #485314 tools-reference: remove the echangelog
>> page #485314
> 
>> appendices/editor-configuration/emacs/text.xml |   4 +- 
>> ebuild-maintenance/text.xml                    | 281 
>> +++++++++++++++++++------
>> ebuild-writing/common-mistakes/text.xml |   2 +-
>> ebuild-writing/misc-files/changelog/text.xml   | 111 ----------
>> ebuild-writing/misc-files/metadata/text.xml    |  16 +- 
>> ebuild-writing/misc-files/text.xml             |   1 - 
>> ebuild-writing/user-submitted/text.xml         |  14 +- 
>> general-concepts/git-to-rsync/diagram.svg      |   2 +- 
>> general-concepts/manifest/text.xml             |   4 +- 
>> general-concepts/mirrors/diagram.svg           |   2 +- 
>> general-concepts/mirrors/text.xml              |   2 +- 
>> general-concepts/tree/text.xml                 |   5 +- 
>> tools-reference/echangelog/text.xml            |  32 --- 
>> tools-reference/text.xml                       |   1 - 14 files 
>> changed, 247 insertions(+), 230 deletions(-) delete mode 100644 
>> ebuild-writing/misc-files/changelog/text.xml delete mode 100644 
>> tools-reference/echangelog/text.xml
> 
> 
> This isn't related to what you're doing but I felt it was a good
> place to ask:
> 
> How are you and other developers creating these series of e-mails?
> It seems really handy and I'd like to know what it is, in the event
> that I need to do the same.
> 
> 

git send-email

- -- 
NP-Hardass
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJWsqZBAAoJEBzZQR2yrxj7+KIP/A8F4Q043VPLxpv2oWJJrrtq
LCRHke5l1V37Ox9gPpvGFs5WLV/CdsXMsisOb3wAPB994FM1NXwuvIbpI6C/FUFY
BG1exENtD7TwYwNvoXcZG+YAd150EKcqEqKPsNQqKxMy6Pl+W3opNBY97J2b4C+R
LOedWHPZtMUr/NuutBso2Av0kZQQlZNIiMThCDzOWiju6gD5uhzTxJ3i0zzxzZRt
vCeyXDaILZoIAzJ6i5X+SK7wxLfzKEyXbVarj6ysY5s20qhjtPovWASzGekdbkSm
g7N1X0ukz/egpa+uo+7I+SR+/uMGRQf2tM4YknhiLzyXtSQ5ciDfNH1DxHpB13v4
DX+jiZCmdiLFyyghxGXcY6n+Gd4MDFXs3CVWcS2JvS5v5qhWR2V1bUvV7NNra0+U
A1+/qPJQtHlEfWkiEZz80qcAzJd8rUtzWktjGhF6osKJ8YzTgFojYmP9M9SHk3hk
U0h1XkrubroooVf43ie9/eLnH0vR/koJWoUfijoQ4ZB10zCYDppBBWS2ghxabOTu
sbjEUovNRcXRl1lew6x++to17lhQ9labvC5syAeV4g4m6DV8KoR+3FooiD+SJrYz
cK2JW4S1ApKle68NBes9ukrkVM/yK47Wv4BNTq7d+tvcwMoPUhV10+X7UQ04b5DN
OXjG/a/w4+Jmrpn9p+5F
=K+rU
-----END PGP SIGNATURE-----

Re: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[Daniel Campbell]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/03/2016 05:15 PM, NP-Hardass wrote:
> On 02/03/2016 08:10 PM, Daniel Campbell wrote:
>> On 02/03/2016 04:57 PM, gokturk@binghamton.edu wrote:
>>> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
>>> Hi,
> 
>>> This is the third iteration of the patch series that attempts
>>> to update the devmanual for the git migration.
> 
>>> The updates included in the third revision are: - Added a new 
>>> subsection called "Git Commit Message Format" based on the 
>>> commit message format included in the Gentoo Git Workflow wiki 
>>> and the feedback provided on this mailing list. - Based on the 
>>> discussion wrt how well git deals with compressed patches,
>>> I've decided to remove "because git does not play well with
>>> binary files".  It's a policy we have been following for years 
>>> irrespective of how git deals with them. - Rewrote the
>>> subsection on "Removing a package" so it does not use 'git
>>> commit -m'. Rewrote the example and added the corresponding
>>> commit message as an example. - The subsection "User-submitted
>>> Ebuilds" is modified to mention the use of git style tags in
>>> commit messages and a reference to the commit message format
>>> policy section has been added.
> 
>>> You can review the changes on Github for your own convenience:
>>>  
>>> https://github.com/gktrk/devmanual.gentoo.org/compare/master...gktrk:
>
>>> 
devmanual-git-migration-v3
> 
>>> If you want to see the diff between v2 and v3, you can clone
>>> the Github repo and check the diff between the branches 
>>> "devmanual-git-migration-v2" and "devmanual-git-migration-v3".
> 
>>> The HTML version of the devmanual with the proposed changes
>>> can be found at: http://devmanual.qui-gon.org/
> 
>>> Gokturk Yuksek (19): general-concepts/manifest: drop the use of
>>>  "CVS keyword expansion" #558642 general-concepts/mirrors: 
>>> substitute "CVS" with "the git tree" #558642 
>>> general-concepts/tree: substitute "CVS" with "git" #558642 
>>> general-concepts/tree: replace the mention of ChangeLog
>>> #558642 ebuild-writing/misc-files: replace the code for cvs
>>> commit with git #558642 ebuild-writing/user-submitted: do not
>>> put user information in ChangeLog #558642 
>>> appendices/editor-configuration/emacs: remove the CVS related 
>>> setting #558642 ebuild-maintenance: rewrite the text on adding 
>>> binary files to the tree #558642 ebuild-maintenance: rewrite
>>> the subsection on commit policy for git #558642
>>> ebuild-maintenance: rewrite the subsection on upgrading ebuilds
>>> for git #558642 ebuild-maintenance: rewrite the subsection on
>>> moving ebuilds for git #558642 ebuild-maintenance: rewrite the
>>> subsection on removing ebuilds for git #558642
>>> ebuild-maintenance: rewrite the subsection on removing packages
>>> for git #558642 ebuild-maintenance: replace "cvs commit" with
>>> "git commit" #558642 general-concepts/git-to-rsync/diagram:
>>> update the description for git #558642 
>>> general-concepts/git-to-rsync/diagram: update the description
>>> for git #558642 general-concepts/tree: remove the reference to
>>> the ChangeLog #485314 ebuid-maintenance: add a new section
>>> called "Git Commit Message Format" #558642 
>>> ebuild-writing/user-submitted: mention git style tags in commit
>>>  messages #558642
> 
>>> Michael Orlitzky (2): ebuild-writing/misc-files: remove 
>>> ChangeLog section #485314 tools-reference: remove the
>>> echangelog page #485314
> 
>>> appendices/editor-configuration/emacs/text.xml |   4 +- 
>>> ebuild-maintenance/text.xml                    | 281 
>>> +++++++++++++++++++------ 
>>> ebuild-writing/common-mistakes/text.xml |   2 +- 
>>> ebuild-writing/misc-files/changelog/text.xml   | 111
>>> ---------- ebuild-writing/misc-files/metadata/text.xml    |  16
>>> +- ebuild-writing/misc-files/text.xml             |   1 - 
>>> ebuild-writing/user-submitted/text.xml         |  14 +- 
>>> general-concepts/git-to-rsync/diagram.svg      |   2 +- 
>>> general-concepts/manifest/text.xml             |   4 +- 
>>> general-concepts/mirrors/diagram.svg           |   2 +- 
>>> general-concepts/mirrors/text.xml              |   2 +- 
>>> general-concepts/tree/text.xml                 |   5 +- 
>>> tools-reference/echangelog/text.xml            |  32 --- 
>>> tools-reference/text.xml                       |   1 - 14 files
>>>  changed, 247 insertions(+), 230 deletions(-) delete mode
>>> 100644 ebuild-writing/misc-files/changelog/text.xml delete mode
>>> 100644 tools-reference/echangelog/text.xml
> 
> 
>> This isn't related to what you're doing but I felt it was a good 
>> place to ask:
> 
>> How are you and other developers creating these series of
>> e-mails? It seems really handy and I'd like to know what it is,
>> in the event that I need to do the same.
> 
> 
> 
> git send-email
> 
> 
Cool, thanks. I knew git had e-mail features but hadn't trawled
through the manpage to see what they were all about. I didn't know it
was so easy! :)


- -- 
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJWsq3MAAoJEAEkDpRQOeFwHeMP/Aqe8YXadcxVznq2MH8R95zO
QckAv24Fr/fJU5Exkx3Av4zkFxvFyMZeidPLO5KxRV5e5jNXZl55xW6cptvPtwZ9
OgJRCbRcYLFnbXSfl3LnL95Bk8XTnGt4Z0qp2X6hr03ELfrvyz1m2vHTxakCEgOX
EsMiAErlZjLREIB8/L6W7a6HPyhNPQTVq2lLiwsHDCvr8uDeAy2NtniwZYAsD+3e
Jui+cdEzVe0EWmq54jjbe9odC4oXr8AW2fiLlQvwFf1PU6q1B38BmpHl7EAw2eOx
t4y7Gqz+MMAM6nzNZn61052C1RRKjL1nyzuIloUwLgD2n03142uX7VTjdyjVTbaR
s0TvBucUg5BEAcbLNOxYUb/iUehRY9Xb9hTvInXi46YZARpxMH0OY/o3h6fRHxsu
lIHM9k0BnhfGE43LXgV7adsk+Qc7CVArSH4mGJVqrvnrabxothsmAzNL8UhO9BML
nEyURNcicIKWVVwLllqnEzOqmjOzKzHSAKOz4X3upimLMGJtZRnhpWrAmLJB4EP4
HnBTo+AQTbCmjzqBvl9JUjRYTs6m/XjcisKY1I2ehdz7qRs03MAT1p8qsN9VaJeO
PTXwVoFTpOoDqQ9y0F5vpQ8j2fZ7/gwHuJcQOddoQhDGzSHbS94ST3XNQTZeJ4qq
UgSqTL95VUPUe9yDPL7B
=ynHz
-----END PGP SIGNATURE-----

Re: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[Göktürk Yüksek]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Daniel Campbell:
> On 02/03/2016 04:57 PM, gokturk@binghamton.edu wrote:
>> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
>> Hi,
> 
> [...]
> 
> This isn't related to what you're doing but I felt it was a good 
> place to ask:
> 
> How are you and other developers creating these series of e-mails? 
> It seems really handy and I'd like to know what it is, in the
> event that I need to do the same.
> 
> 

Here's how I do it: Make your commits on a separate branch as if you'd
push them directly to the repo. Use 'git format-patch' to generate
patch files and use 'git send-email' to send them. You can skip
format-patch and just use send-email but for a changeset of 21 commits
I'd like to take another look.

git format-patch --stat --summary -o bug558642_v3/ -n -v3
- --cover-letter master..devmanual-git-migration-v3

Creates the patches. '--cover-letter' creates a special patch file
that requires editing which becomes the first email in the series,
which is the one you replied to.

Once satisfied, I sent it with:

git send-email *

Keep in mind that git will CC authors of the patches and yourself to
the email. So you may have to adjust those.

Don't forget to edit your .gitconfig and set proper SMTP options in
the [sendemail] section.

- --
gokturk
-----BEGIN PGP SIGNATURE-----

iQEcBAEBCgAGBQJWsq3CAAoJEIT4AuXAiM4zuIEH/AvY3LYbcPMONlA5KuXTYTBG
8AtgqynEmQ0Qt1XujbC8W2bsKRMiUi8Xbtttnm/urfVCzCDKVQrzIkIA4x4kqIxA
HKYgLuqE2zLxfLrbJkB0W3F1ogNOt1fuxzR9HSlasgqOSh13tpexINvI77iC4U0T
7ZlUeRv5R7AqvObEZO+2hY3JkHCELgD4lwRkNwjzqNVqJLJOVUev3wXid38GBPf2
qQUEUdZw5XuM5ygFM0r5ZgP2X8HEs5FfB9ouAHGuw7d/Kr+R3L+vH1v5g4+D+n1f
iink8nR2LMrcBRiQ4/tbXyBgBiu/jZeG5UTJfQte3jyOuP4kf65SFADW+3B4+cc=
=46ba
-----END PGP SIGNATURE-----

Re: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration

[Daniel Campbell]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 02/03/2016 05:49 PM, Göktürk Yüksek wrote:
> Daniel Campbell:
>> On 02/03/2016 04:57 PM, gokturk@binghamton.edu wrote:
>>> From: Gokturk Yuksek <gokturk@binghamton.edu>
> 
>>> Hi,
> 
>> [...]
> 
>> This isn't related to what you're doing but I felt it was a good
>>  place to ask:
> 
>> How are you and other developers creating these series of
>> e-mails? It seems really handy and I'd like to know what it is,
>> in the event that I need to do the same.
> 
> 
> 
> Here's how I do it: Make your commits on a separate branch as if
> you'd push them directly to the repo. Use 'git format-patch' to
> generate patch files and use 'git send-email' to send them. You can
> skip format-patch and just use send-email but for a changeset of 21
> commits I'd like to take another look.
> 
> git format-patch --stat --summary -o bug558642_v3/ -n -v3 
> --cover-letter master..devmanual-git-migration-v3
> 
> Creates the patches. '--cover-letter' creates a special patch file 
> that requires editing which becomes the first email in the series, 
> which is the one you replied to.
> 
> Once satisfied, I sent it with:
> 
> git send-email *
> 
> Keep in mind that git will CC authors of the patches and yourself
> to the email. So you may have to adjust those.
> 
> Don't forget to edit your .gitconfig and set proper SMTP options
> in the [sendemail] section.
> 
> 
Awesome; between the manpage and your example this is a great primer!
Thanks a lot for explaining your workflow. I'm sure it's useful to
more than just myself.


- -- 
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJWsq8HAAoJEAEkDpRQOeFw+HUP/2QEbZNPNmrZGM2DGVzAIY+/
wQvGpIq8IO6SQ6pQH8FLFeTb17Y2x+SB04rYqv3bpbOV/GjSPwAomObLBa4GUU74
QTnZ7p4ZfMxisiZd5IfFPNMuY2YTpT2TfRez1TPxdty+4w9aE/MjYNvk/pTqhc4D
fVI8NdMixP8obDozXqvqKSV2uh0smE82aFleAN7yQ9pEplV/282UqdcFRIQs6iXX
7gCxZvTbaXTuvukda8D8uABrZSvZhORjZ4TmnZfEHQcih9byF9smk/Ao1uNbTXG2
iJRkvDld0wfkar6o8zoX9tEjwwpVXfSSjnDcEZSYYO90Q3aY3HNWttcgRilD4HXA
wd57r5eDZUM82IY70oGhHPDEeW+lXoKgp3B8LYQCdGOJRLgSPC6F9WGvAvf/qK8h
ULg1WPbjMudWU1gnzNxaX2f3WT6+RoyZccpUMKNg/Ku2glG/6ZVPbkpm8Z4Uo/yd
iuhpCcs3HVHWvZS7ggJk7FysxlBwH5Zd4+88USo/HujUfjkdvJgZ7COAV8DTikAg
3n2U+MFIUDwjfp014MgKKTdTt0Cj2n87LPCeQN+hEeGPOfz6jAr2TBrRGdyCEHBi
aYHbny9tFs3na4HJhBquE5Esm159T+RY7Ff7br1zzIu8hhNNIlCsN8xxRku9jCsx
wT5s3gCj/o4ElV+EumhX
=BZ+P
-----END PGP SIGNATURE-----