public inbox for gentoo-doc@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642
@ 2016-01-17  7:55 Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 01/16] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
                   ` (16 more replies)
  0 siblings, 17 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Hi,

The following patch series attempt to update devmanual to replace the instances
of CVS with their git equivalents. I tried to keep the changes small in favor
of updating the docs over multiple iterations of patch series. The intention is
to get the bare bone changes in so that the quiz questions can be answered.

Currently not included in the series are:
- References to CVS in sections about herds since they will have to be
  rewritten per GLEP 67 soon anyway.
  See: https://bugs.gentoo.org/show_bug.cgi?id=572144
- I am not sure about what to do with the subsection
  Ebuild Functions/Miscellaneous Files/ChangeLog. The ChangeLog files
  still exist in the rsync tree, however they are of little importance
  in terms of development.

Gokturk Yuksek (16):
  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

 appendices/editor-configuration/emacs/text.xml |  2 +-
 ebuild-maintenance/text.xml                    | 77 ++++++++++----------------
 ebuild-writing/common-mistakes/text.xml        |  2 +-
 ebuild-writing/misc-files/metadata/text.xml    |  3 +-
 ebuild-writing/user-submitted/text.xml         |  8 ++-
 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                 |  4 +-
 10 files changed, 44 insertions(+), 62 deletions(-)

-- 
2.4.10



^ permalink raw reply	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 01/16] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 02/16] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642 Gokturk Yuksek
                   ` (15 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 02/16] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 01/16] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 03/16] general-concepts/tree: substitute "CVS" with "git" #558642 Gokturk Yuksek
                   ` (14 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 03/16] general-concepts/tree: substitute "CVS" with "git" #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 01/16] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 02/16] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 04/16] general-concepts/tree: replace the mention of ChangeLog #558642 Gokturk Yuksek
                   ` (13 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 04/16] general-concepts/tree: replace the mention of ChangeLog #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (2 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 03/16] general-concepts/tree: substitute "CVS" with "git" #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 05/16] ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Gokturk Yuksek
                   ` (12 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 05/16] ebuild-writing/misc-files: replace the code for cvs commit with git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (3 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 04/16] general-concepts/tree: replace the mention of ChangeLog #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 06/16] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 Gokturk Yuksek
                   ` (11 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index e506b1c..a8beacc 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -532,7 +532,8 @@ 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 -m "Adding category metadata.xml for my-category"
 </pre>
 
 </body>
-- 
2.4.10



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 06/16] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (4 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 05/16] ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 07/16] appendices/editor-configuration/emacs: remove the CVS related setting #558642 Gokturk Yuksek
                   ` (10 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml
index ef80c0d..22f8fa8 100644
--- a/ebuild-writing/user-submitted/text.xml
+++ b/ebuild-writing/user-submitted/text.xml
@@ -21,9 +21,11 @@ The user-submitted ebuild must not contain custom headers like this:
 </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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 07/16] appendices/editor-configuration/emacs: remove the CVS related setting #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (5 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 06/16] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 08/16] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
                   ` (9 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/appendices/editor-configuration/emacs/text.xml b/appendices/editor-configuration/emacs/text.xml
index 55fade0..37c5504 100644
--- a/appendices/editor-configuration/emacs/text.xml
+++ b/appendices/editor-configuration/emacs/text.xml
@@ -48,7 +48,7 @@ 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
+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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 08/16] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (6 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 07/16] appendices/editor-configuration/emacs: remove the CVS related setting #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 09/16] ebuild-maintenance: rewrite the subsection on commit policy for git #558642 Gokturk Yuksek
                   ` (8 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Remove the paragraph about adding binary files to CVS.
Replace the instances of CVS with git.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index ac68dcd..10709ea 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 because git does not play well with binary files.
 </p>
 
 <p>
-- 
2.4.10



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 09/16] ebuild-maintenance: rewrite the subsection on commit policy for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (7 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 08/16] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 10/16] ebuild-maintenance: rewrite the subsection on upgrading ebuilds " Gokturk Yuksek
                   ` (7 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

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.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 10709ea..2d46749 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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 10/16] ebuild-maintenance: rewrite the subsection on upgrading ebuilds for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (8 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 09/16] ebuild-maintenance: rewrite the subsection on commit policy for git #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 11/16] ebuild-maintenance: rewrite the subsection on moving " Gokturk Yuksek
                   ` (6 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Substitute the mentions of CVS with git.
Rewrite CVS commands with their git equivalents.
Delete the reference to editing ChangeLog.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 2d46749..a1d92a1 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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 11/16] ebuild-maintenance: rewrite the subsection on moving ebuilds for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (9 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 10/16] ebuild-maintenance: rewrite the subsection on upgrading ebuilds " Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 12/16] ebuild-maintenance: rewrite the subsection on removing " Gokturk Yuksek
                   ` (5 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Substitute the mentions of CVS with git.
Rewrite CVS commands with their git equivalents.
Remove the paragraph about deleting directories in CVS.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index a1d92a1..8c542d0 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -298,7 +298,7 @@ Moving ebuilds is a two-step process:
 </p>
 
 <p>
-Firstly, you need to move the ebuild in CVS. To do this, you should
+Firstly, you need to move the ebuild in the git tree. 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>
@@ -323,23 +323,17 @@ for <path>net-firewall/fwbuilder</path> when they are available.
 
 <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
+Simply issue a <c>git rm -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.
 </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."
+net-misc # git rm -rf fwbuilder
+net-misc # git commit --gpg-sign -m "Moving net-misc/fwbuilder to net-firewall/fwbuilder."
 </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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 12/16] ebuild-maintenance: rewrite the subsection on removing ebuilds for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (10 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 11/16] ebuild-maintenance: rewrite the subsection on moving " Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 13/16] ebuild-maintenance: rewrite the subsection on removing packages " Gokturk Yuksek
                   ` (4 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Substitute the mentions of CVS with git.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 8c542d0..4078d46 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -364,8 +364,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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 13/16] ebuild-maintenance: rewrite the subsection on removing packages for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (11 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 12/16] ebuild-maintenance: rewrite the subsection on removing " Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 14/16] ebuild-maintenance: replace "cvs commit" with "git commit" #558642 Gokturk Yuksek
                   ` (3 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

Substitute the mentions of CVS with git.
Rewrite CVS commands with their git equivalents.
Remove the paragraph about deleting directories in CVS.

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 4078d46..7014689 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -396,20 +396,15 @@ 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.
-</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> app-admin
+<comment>#</comment> <keyword>git</keyword> rm -rf scotty
+<comment>#</comment> <keyword>git</keyword> commit --gpg-sign -m "app-admin/scotty: removal (pending 21st July 2006), see #77501 for reference." scotty</pre>
 
 </body>
 </section>
-- 
2.4.10



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 14/16] ebuild-maintenance: replace "cvs commit" with "git commit" #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (12 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 13/16] ebuild-maintenance: rewrite the subsection on removing packages " Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 15/16] general-concepts/git-to-rsync/diagram: update the description for git #558642 Gokturk Yuksek
                   ` (2 subsequent siblings)
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 7014689..6dc8813 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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 15/16] general-concepts/git-to-rsync/diagram: update the description for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (13 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 14/16] ebuild-maintenance: replace "cvs commit" with "git commit" #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 16/16] " Gokturk Yuksek
  2016-01-17 15:59 ` [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Sven Vermeulen
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* [gentoo-doc] [PATCH 16/16] general-concepts/git-to-rsync/diagram: update the description for git #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (14 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 15/16] general-concepts/git-to-rsync/diagram: update the description for git #558642 Gokturk Yuksek
@ 2016-01-17  7:55 ` Gokturk Yuksek
  2016-01-17 15:59 ` [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Sven Vermeulen
  16 siblings, 0 replies; 18+ messages in thread
From: Gokturk Yuksek @ 2016-01-17  7:55 UTC (permalink / raw
  To: gentoo-dev, gentoo-doc; +Cc: Gokturk Yuksek

X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=558642
Signed-off-by: Gokturk Yuksek <gokturk@binghamton.edu>

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



^ permalink raw reply related	[flat|nested] 18+ messages in thread

* Re: [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642
  2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
                   ` (15 preceding siblings ...)
  2016-01-17  7:55 ` [gentoo-doc] [PATCH 16/16] " Gokturk Yuksek
@ 2016-01-17 15:59 ` Sven Vermeulen
  16 siblings, 0 replies; 18+ messages in thread
From: Sven Vermeulen @ 2016-01-17 15:59 UTC (permalink / raw
  To: gentoo-doc

On Sun, Jan 17, 2016 at 02:55:03AM -0500, Gokturk Yuksek wrote:
> The following patch series attempt to update devmanual to replace the instances
> of CVS with their git equivalents. I tried to keep the changes small in favor
> of updating the docs over multiple iterations of patch series. The intention is
> to get the bare bone changes in so that the quiz questions can be answered.

Hi Gokturk

Just for your information (in case you have certain expectations), the
devmanual is not managed as part of the gentoo documentation project (which
is more for end-user documentation, and has shifted focus completely to the
Gentoo Wiki).

See https://wiki.gentoo.org/wiki/Project:Devmanual for information about the
devmanual.

Wkr,
	Sven Vermeulen


^ permalink raw reply	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2016-01-17 15:59 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-01-17  7:55 [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 01/16] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 02/16] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 03/16] general-concepts/tree: substitute "CVS" with "git" #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 04/16] general-concepts/tree: replace the mention of ChangeLog #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 05/16] ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 06/16] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 07/16] appendices/editor-configuration/emacs: remove the CVS related setting #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 08/16] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 09/16] ebuild-maintenance: rewrite the subsection on commit policy for git #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 10/16] ebuild-maintenance: rewrite the subsection on upgrading ebuilds " Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 11/16] ebuild-maintenance: rewrite the subsection on moving " Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 12/16] ebuild-maintenance: rewrite the subsection on removing " Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 13/16] ebuild-maintenance: rewrite the subsection on removing packages " Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 14/16] ebuild-maintenance: replace "cvs commit" with "git commit" #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 15/16] general-concepts/git-to-rsync/diagram: update the description for git #558642 Gokturk Yuksek
2016-01-17  7:55 ` [gentoo-doc] [PATCH 16/16] " Gokturk Yuksek
2016-01-17 15:59 ` [gentoo-doc] [PATCH 00/16] devmanual: update the docs for post git-migration #558642 Sven Vermeulen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox