* [gentoo-dev] [PATCH v2 01/19] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
@ 2016-01-24 8:45 ` Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 02/19] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642 Gokturk Yuksek
` (17 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:45 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 02/19] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 01/19] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
@ 2016-01-24 8:45 ` Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 03/19] general-concepts/tree: substitute "CVS" with "git" #558642 Gokturk Yuksek
` (16 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:45 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 03/19] general-concepts/tree: substitute "CVS" with "git" #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 01/19] general-concepts/manifest: drop the use of "CVS keyword expansion" #558642 Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 02/19] general-concepts/mirrors: substitute "CVS" with "the git tree" #558642 Gokturk Yuksek
@ 2016-01-24 8:45 ` Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 04/19] general-concepts/tree: replace the mention of ChangeLog #558642 Gokturk Yuksek
` (15 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:45 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 04/19] general-concepts/tree: replace the mention of ChangeLog #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (2 preceding siblings ...)
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 03/19] general-concepts/tree: substitute "CVS" with "git" #558642 Gokturk Yuksek
@ 2016-01-24 8:45 ` Gokturk Yuksek
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 05/19] ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Gokturk Yuksek
` (14 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:45 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 05/19] ebuild-writing/misc-files: replace the code for cvs commit with git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (3 preceding siblings ...)
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 04/19] general-concepts/tree: replace the mention of ChangeLog #558642 Gokturk Yuksek
@ 2016-01-24 8:45 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 06/19] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 Gokturk Yuksek
` (13 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:45 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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 <aballier@gentoo.org>
+Date: Tue Sep 22 10:47:49 2015 +0200
+
+ dev-ros: Add metadata.xml for the category.
</pre>
</body>
--
2.4.10
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 06/19] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (4 preceding siblings ...)
2016-01-24 8:45 ` [gentoo-dev] [PATCH v2 05/19] ebuild-writing/misc-files: replace the code for cvs commit with git #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 07/19] appendices/editor-configuration/emacs: remove the CVS related setting #558642 Gokturk Yuksek
` (12 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
ebuild-writing/user-submitted/text.xml | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 07/19] appendices/editor-configuration/emacs: remove the CVS related setting #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (5 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 06/19] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
` (11 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
appendices/editor-configuration/emacs/text.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (6 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 07/19] appendices/editor-configuration/emacs: remove the CVS related setting #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 15:00 ` Patrice Clement
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 09/19] ebuild-maintenance: rewrite the subsection on commit policy for git #558642 Gokturk Yuksek
` (10 subsequent siblings)
18 siblings, 1 reply; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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..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] 33+ messages in thread
* Re: [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
@ 2016-01-24 15:00 ` Patrice Clement
2016-01-24 15:29 ` [gentoo-dev] " Duncan
` (2 more replies)
0 siblings, 3 replies; 33+ messages in thread
From: Patrice Clement @ 2016-01-24 15:00 UTC (permalink / raw
To: gentoo-dev; +Cc: devmanual
Sunday 24 Jan 2016 03:46:02, Gokturk Yuksek wrote :
> 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>
> ---
> 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..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
>
>
"Again you should not compress these patches because git does not play well
binary files".
I'm not sure this statement still holds true with git. Does it?
--
Patrice Clement
Gentoo Linux developer
http://www.gentoo.org
^ permalink raw reply [flat|nested] 33+ messages in thread
* [gentoo-dev] Re: [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 15:00 ` Patrice Clement
@ 2016-01-24 15:29 ` Duncan
2016-01-24 15:44 ` [gentoo-dev] " Andrew Savchenko
2016-01-24 16:38 ` Göktürk Yüksek
2 siblings, 0 replies; 33+ messages in thread
From: Duncan @ 2016-01-24 15:29 UTC (permalink / raw
To: gentoo-dev
Patrice Clement posted on Sun, 24 Jan 2016 16:00:31 +0100 as excerpted:
> "Again you should not compress these patches because git does not play
> well binary files".
>
> I'm not sure this statement still holds true with git. Does it?
It does.
Git is designed to be extremely efficient at distributed source version
control, and works best with text-based sources which it can treat
"intelligently". Not only does it do its own text compression in the pak
files, it's relatively dumb in terms of binary differences, being able to
tell a binary file changed, but effectively considering it a single file
level change while with text it does line-level tracking.
By compressing a patch or doing a tarball, you're effectively turning it
into a single blob in terms of tracking, while as the uncompressed text-
based patch-files, git can not only track the individual files, but
individual lines within them. While with patch-files losing the
individual line tracking isn't generally a huge loss (the patches tend to
be replaced as a whole, without line-level changes within a single
patch), losing the per-component-patch file tracking is.
--
Duncan - List replies preferred. No HTML msgs.
"Every nonfree program has a lord, a master --
and if you use the program, he is your master." Richard Stallman
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 15:00 ` Patrice Clement
2016-01-24 15:29 ` [gentoo-dev] " Duncan
@ 2016-01-24 15:44 ` Andrew Savchenko
2016-01-24 23:44 ` Göktürk Yüksek
2016-01-24 16:38 ` Göktürk Yüksek
2 siblings, 1 reply; 33+ messages in thread
From: Andrew Savchenko @ 2016-01-24 15:44 UTC (permalink / raw
To: gentoo-dev
[-- Attachment #1: Type: text/plain, Size: 2769 bytes --]
On Sun, 24 Jan 2016 16:00:31 +0100 Patrice Clement wrote:
> Sunday 24 Jan 2016 03:46:02, Gokturk Yuksek wrote :
> > 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>
> > ---
> > 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..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
> >
> >
>
> "Again you should not compress these patches because git does not play well
> binary files".
>
> I'm not sure this statement still holds true with git. Does it?
What about repoman checks? Will it still yell at >20 kB patches?
Best regards,
Andrew Savchenko
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 15:44 ` [gentoo-dev] " Andrew Savchenko
@ 2016-01-24 23:44 ` Göktürk Yüksek
2016-01-25 0:51 ` Brian Dolbec
0 siblings, 1 reply; 33+ messages in thread
From: Göktürk Yüksek @ 2016-01-24 23:44 UTC (permalink / raw
To: gentoo-dev
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Andrew Savchenko:
> On Sun, 24 Jan 2016 16:00:31 +0100 Patrice Clement wrote:
>> Sunday 24 Jan 2016 03:46:02, Gokturk Yuksek wrote :
>>> 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> ---
>>> 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..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
>>>
>>>
>>
>> "Again you should not compress these patches because git does
>> not play well binary files".
>>
>> I'm not sure this statement still holds true with git. Does it?
>
> What about repoman checks? Will it still yell at >20 kB patches?
>
Yessir:
https://gitweb.gentoo.org/proj/portage.git/tree/pym/repoman/checks/ebuilds/fetches.py?h=v2.2.27#n104
Even though it's not an issue with the git tree, rsync users will
still suffer for >20kB patches.
> Best regards, Andrew Savchenko
>
- --
gokturk
-----BEGIN PGP SIGNATURE-----
iQEcBAEBCgAGBQJWpWG/AAoJEIT4AuXAiM4zL4kIAJOQXCo2veG56lBhFjbYcusi
KZwJUbSpzLW6liZYlVYE6lYLsi7m/AW0jNhTWHt4P6vqsyhSzvS+GzchZbPzmzel
j9dSurvwVEtrAucLbinQ95Ym8biRVREw6ieC3D+cMZbsd9+yvLdA9vWvIDneOA09
BsTmibtNHXg3xusDhuAK3hl8lxZhu5dK0n733Mm/S3gnDJ952dGyQjIMxZhxdwSd
QOK2VTRfUJx0hAoNUPNqd0flOCBfijdOR7qFDZuVNsyqZwTW7Du+k8uz8uRV+hKp
4dktGALgDh4tTd6O8kCrQBTBQ2IVC03Fvs3xvAYFV84WNug3tEYRB2mDUpGBzck=
=bpVR
-----END PGP SIGNATURE-----
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 23:44 ` Göktürk Yüksek
@ 2016-01-25 0:51 ` Brian Dolbec
0 siblings, 0 replies; 33+ messages in thread
From: Brian Dolbec @ 2016-01-25 0:51 UTC (permalink / raw
To: gentoo-dev
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
On Sun, 24 Jan 2016 18:44:08 -0500
Göktürk Yüksek <gokturk@binghamton.edu> wrote:
> Andrew Savchenko:
> > On Sun, 24 Jan 2016 16:00:31 +0100 Patrice Clement wrote:
> >> Sunday 24 Jan 2016 03:46:02, Gokturk Yuksek wrote :
> >>> 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> ---
> >>> 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..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
> >>>
> >>>
> >>
> >> "Again you should not compress these patches because git does
> >> not play well binary files".
> >>
> >> I'm not sure this statement still holds true with git. Does it?
> >
> > What about repoman checks? Will it still yell at >20 kB patches?
> >
> Yessir:
> https://gitweb.gentoo.org/proj/portage.git/tree/pym/repoman/checks/ebuilds/fetches.py?h=v2.2.27#n104
>
> Even though it's not an issue with the git tree, rsync users will
> still suffer for >20kB patches.
>
> > Best regards, Andrew Savchenko
> >
>
> - --
> gokturk
>
>
just for future reference, here it is again in the repoman rewtire code
waiting to be merged and likely be in the next release:
https://gitweb.gentoo.org/proj/portage.git/tree/pym/repoman/modules/scan/fetch/fetches.py?h=repoman#n109
- --
Brian Dolbec <dolsen>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.1
iQJ8BAEBCgBmBQJWpXF6XxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w
ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXRBNUQ3Qzc0RTA4MUNDNzBEQjRBNEFBRjVG
QkJEMDg3Mjc1ODIwRUQ4AAoJEPu9CHJ1gg7YV6IP/34NmzdtaMg4W471cXYn8pR0
8JdcHkC2YehpNNzSjDbWmI9pEArBS/3yWC8lfXMeu21GU66OUb6eKR5KMURg5OP9
FT4DJCHO9RWK31QEOD03PLZXhoaw6JgYQpvjbnWP1CN8mdWg7CeA0r0y4BPe63Kp
FGpFZXjduszpT1ALIt86tN85pB9jmYdwDgj9vLWG6SyThFuA6aDeEHSaAB05blDU
p6NVksGfSG6bbS+Kok1uRdF5vVqBQU+aSxNbZW9mpRtYDtdr5DoInbq/uXz/Dy1S
Kp7iDg8+SW3nwA60vqss5SZmZDW3cnEH1XWIdEgDjH4NBvlaVnA9yxIa12MJ6qSy
FZ+5F5HVAdRs8eLK0OsK/RbFm4gCEFxmhm6YJ2qXpIXuD/MM4GJXJa+O7qrURzqI
td5rJNTHGbIBmwDjJwotwyuT+FgWajicbrnQpxgiLoNYcvvB7mihwT+DFKx4WxWm
rw2O21fFaUD/OQp255y0OLyVfVC6SRk3UXXlDd9Pl+UYLLIyC6ibVI4dxDxp4hd2
DGUTQ2FFm3m4h5RTxeCJNJgTMlKSbCyDut6vM8mMyIzMxcD5nfWFv53KNIbOPfGH
vmUbc5scrhKLiawzos2w+ChzGkzGParzCF7rZ1S2nOlJFt87qgVVs7JNVUJ0D1QX
XlmqJV+fmRhaDLRXNVQA
=gmwE
-----END PGP SIGNATURE-----
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642
2016-01-24 15:00 ` Patrice Clement
2016-01-24 15:29 ` [gentoo-dev] " Duncan
2016-01-24 15:44 ` [gentoo-dev] " Andrew Savchenko
@ 2016-01-24 16:38 ` Göktürk Yüksek
2016-01-24 17:17 ` James Le Cuirot
2 siblings, 1 reply; 33+ messages in thread
From: Göktürk Yüksek @ 2016-01-24 16:38 UTC (permalink / raw
To: gentoo-dev
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Patrice Clement:
> Sunday 24 Jan 2016 03:46:02, Gokturk Yuksek wrote :
>> 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> ---
>> 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..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
>>
>>
>
> "Again you should not compress these patches because git does not
> play well binary files".
>
> I'm not sure this statement still holds true with git. Does it?
>
It should be possible to compress the patches and use gitattributes[1]
to tell git to decompress them before diffing. But doing so is not
needed since git compresses its objects in the first place. Maybe we
can rewrite this as "You should not compress these patches because git
compresses them upon commit transparently."
With that being said, git may in fact not play well with binary files
given that there is an extension to handle binary files[2].
[1]
https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Binary-Files
[2] http://www.infoq.com/news/2015/04/github-large-file-storage
- --
gokturk
-----BEGIN PGP SIGNATURE-----
iQEcBAEBCgAGBQJWpP4NAAoJEIT4AuXAiM4zhNkH/jcQBQG/omfDSjbE/zBYjm+E
L6omW3vmaSHUwAt7YG62Nmnp2dh3s7xBIl09f1VhAEDxvj9lQR+VtyWZhQFMEnQ8
OZb4o97h/PWUsI4qEuWRENGEzhI3vQDGDIRJhvxDlzgwTXUtMS89PvPIducc/HUf
9a81AHc8a7kRKFNmaaQj2pxuf1zQ6K7tZh9SMvZh31bqkPDgLNHVy1eJregB5IM/
0lzZuODsXDuWMBE2awP9Y02MUEspjPt2RaAhSXa2StCaUcCmd6RmX+aSaQxb3C05
tXXNadXyws5Lg6HvtnQq6Xb1Sz/G5gUJRnJ9IFIK8B8fGYuqaJgb+uUqIAGboFY=
=xn2m
-----END PGP SIGNATURE-----
^ permalink raw reply [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 09/19] ebuild-maintenance: rewrite the subsection on commit policy for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (7 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 08/19] ebuild-maintenance: rewrite the text on adding binary files to the tree #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 10/19] ebuild-maintenance: rewrite the subsection on upgrading ebuilds " Gokturk Yuksek
` (9 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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 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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 10/19] ebuild-maintenance: rewrite the subsection on upgrading ebuilds for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (8 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 09/19] ebuild-maintenance: rewrite the subsection on commit policy for git #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 11/19] ebuild-maintenance: rewrite the subsection on moving " Gokturk Yuksek
` (8 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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 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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 11/19] ebuild-maintenance: rewrite the subsection on moving ebuilds for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (9 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 10/19] ebuild-maintenance: rewrite the subsection on upgrading ebuilds " Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 12/19] ebuild-maintenance: rewrite the subsection on removing " Gokturk Yuksek
` (7 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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.
X-Gentoo-Bug-URL: 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 a1d92a1..09c5eef 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 <amadio@gentoo.org>
+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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 12/19] ebuild-maintenance: rewrite the subsection on removing ebuilds for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (10 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 11/19] ebuild-maintenance: rewrite the subsection on moving " Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 13/19] ebuild-maintenance: rewrite the subsection on removing packages " Gokturk Yuksek
` (6 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
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 09c5eef..1a0e1a0 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 13/19] ebuild-maintenance: rewrite the subsection on removing packages for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (11 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 12/19] ebuild-maintenance: rewrite the subsection on removing " Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 14/19] ebuild-maintenance: replace "cvs commit" with "git commit" #558642 Gokturk Yuksek
` (5 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
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>
---
ebuild-maintenance/text.xml | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index 1a0e1a0..11ab2d4 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -428,20 +428,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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 14/19] ebuild-maintenance: replace "cvs commit" with "git commit" #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (12 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 13/19] ebuild-maintenance: rewrite the subsection on removing packages " Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 15/19] general-concepts/git-to-rsync/diagram: update the description for git #558642 Gokturk Yuksek
` (4 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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 11ab2d4..dc24386 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] 33+ messages in thread
* [gentoo-dev] [PATCH v2 15/19] general-concepts/git-to-rsync/diagram: update the description for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (13 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 14/19] ebuild-maintenance: replace "cvs commit" with "git commit" #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 16/19] " Gokturk Yuksek
` (3 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 16/19] general-concepts/git-to-rsync/diagram: update the description for git #558642
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (14 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 15/19] general-concepts/git-to-rsync/diagram: update the description for git #558642 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314 Gokturk Yuksek
` (2 subsequent siblings)
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (15 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 16/19] " Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-25 0:43 ` [gentoo-dev] " Ulrich Mueller
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 18/19] tools-reference: remove the echangelog page #485314 Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 19/19] general-concepts/tree: remove the reference to the ChangeLog #485314 Gokturk Yuksek
18 siblings, 1 reply; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev, Michael Orlitzky
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.
X-Gentoo-Bug-URL: 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(-)
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 <ciaranm@gentoo.org> +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 <agriffis@gentoo.org> 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314 Gokturk Yuksek
@ 2016-01-25 0:43 ` Ulrich Mueller
2016-01-25 1:02 ` Göktürk Yüksek
2016-01-25 1:13 ` Michael Orlitzky
0 siblings, 2 replies; 33+ messages in thread
From: Ulrich Mueller @ 2016-01-25 0:43 UTC (permalink / raw
To: Gokturk Yuksek; +Cc: devmanual, gentoo-dev, Michael Orlitzky
[-- Attachment #1: Type: text/plain, Size: 513 bytes --]
>>>>> On Sun, 24 Jan 2016, Gokturk Yuksek wrote:
> 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.
Most of that section contains information that will still apply, even
if it no longer goes into a ChangeLog but a into a git commit message.
Therefore the section shouldn't be removed, but rather be updated.
Ulrich
[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]
^ permalink raw reply [flat|nested] 33+ messages in thread
* [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-25 0:43 ` [gentoo-dev] " Ulrich Mueller
@ 2016-01-25 1:02 ` Göktürk Yüksek
2016-01-25 1:13 ` Michael Orlitzky
1 sibling, 0 replies; 33+ messages in thread
From: Göktürk Yüksek @ 2016-01-25 1:02 UTC (permalink / raw
To: Ulrich Mueller; +Cc: devmanual, gentoo-dev, Michael Orlitzky
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Ulrich Mueller:
>>>>>> On Sun, 24 Jan 2016, Gokturk Yuksek wrote:
>
>> 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.
>
> Most of that section contains information that will still apply,
> even if it no longer goes into a ChangeLog but a into a git commit
> message.
>
> Therefore the section shouldn't be removed, but rather be updated.
>
What if we extract the information regarding writing good commit
messages and move it under ebuild-maintenance, possibly as a new
subsection or under the subsection "Git Commit Policy"?
I agree that the information there is valuable but a better
documentation is available on the git workflow wiki[1]. We can
alternatively insert a link to the wiki page instead or import the
same information. But keeping the two in sync will be problematic.
> Ulrich
>
[1] https://wiki.gentoo.org/wiki/Gentoo_git_workflow#Commit_message_form
at
- --
gokturk
-----BEGIN PGP SIGNATURE-----
iQEcBAEBCgAGBQJWpXQZAAoJEIT4AuXAiM4zgxIH/AwU3j8TMpYB7m+1Eeyg19wL
nuY2YwDaev2KnEN8tmhqksCjyRJM9MvZpPXUfIvtaQBAFknYKPP3cI7leLQaQvUD
pu0bMjfv3NIEM8Ux9tuWfeTYaBmnqOi1k9aFkCwIrpktDDjgz90KBq9ua40V1gEz
aSAjaMZEs4YCZY/lTsgudPYCEQIiOkNfeC0riSSPnvG4Mp+LxZr3wcaudlFE57FZ
hkNkjsTsLCqjmNCxI8FNYDiWqA+uueSkEWan3xjJV3bl8iJc82lcZoRayO5cwuDU
CNNpDBABw9YDA6IrBNxpq/MxunKhdc2RuUFQmsw9I69WIWxwS555sxlMGugQGQ8=
=9AN4
-----END PGP SIGNATURE-----
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-25 0:43 ` [gentoo-dev] " Ulrich Mueller
2016-01-25 1:02 ` Göktürk Yüksek
@ 2016-01-25 1:13 ` Michael Orlitzky
2016-01-25 8:17 ` Ulrich Mueller
1 sibling, 1 reply; 33+ messages in thread
From: Michael Orlitzky @ 2016-01-25 1:13 UTC (permalink / raw
To: gentoo-dev
On 01/24/2016 07:43 PM, Ulrich Mueller wrote:
>>>>>> On Sun, 24 Jan 2016, Gokturk Yuksek wrote:
>
>> 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.
>
> Most of that section contains information that will still apply, even
> if it no longer goes into a ChangeLog but a into a git commit message.
>
> Therefore the section shouldn't be removed, but rather be updated.
>
We will eventually need a "Commit Messages" page, but in my opinion the
bar for these sorts of patches should be "does it make things better?"
If so, merge it, and if you want to improve the result, do that.
Otherwise nothing gets done.
The ChangeLog page is nonsense as-is, and removing it makes the
devmanual better. Afterwards, if someone wants to take the commit
message guidelines from the wiki and merge them with the old ChangeLog
tips, great. There's only two things worth salvaging from the ChangeLog
page. Here's the combined list:
1. Everything from the Git workflow wiki page "Commit message format"
section.
2. Mention the "Gentoo-Bug:" identifier. Using "bug #12345" in the
commit message itself causes trouble. If you word-wrap on the
"#12345", it will silently clobber the message.
3. When including user-submitted ebuilds or patches, you should
credit the user with his full name and email address (or
whatever he uses to identify himself on bugzilla — some users
prefer to be known only by a nickname).
3.i. But use the "Reported-By:", "Suggested-By:", etc. mentioned on
the wiki.
4. If you are changing keywords, make sure you clearly state what
keywords you add or remove.
The bad examples at the end of the ChangeLog page are still bad, but the
good examples are now bad too. There's not much worth saving.
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-25 1:13 ` Michael Orlitzky
@ 2016-01-25 8:17 ` Ulrich Mueller
2016-01-27 4:19 ` Göktürk Yüksek
0 siblings, 1 reply; 33+ messages in thread
From: Ulrich Mueller @ 2016-01-25 8:17 UTC (permalink / raw
To: gentoo-dev
[-- Attachment #1: Type: text/plain, Size: 1126 bytes --]
>>>>> On Sun, 24 Jan 2016, Michael Orlitzky wrote:
> The ChangeLog page is nonsense as-is, and removing it makes the
> devmanual better. Afterwards, if someone wants to take the commit
> message guidelines from the wiki and merge them with the old ChangeLog
> tips, great. There's only two things worth salvaging from the ChangeLog
> page. Here's the combined list:
> 1. Everything from the Git workflow wiki page "Commit message format"
> section.
I would say not only that section, but most of the page. The devmanual
is the one central place where our development workflow should be
documented, not some random wiki page.
> 2. Mention the "Gentoo-Bug:" identifier.
Right. (But had we settled for "Gentoo-Bug:"? IIRC, last time this was
discussed there was no consensus.)
> Using "bug #12345" in the commit message itself causes trouble.
> If you word-wrap on the "#12345", it will silently clobber the
> message.
That's one of the reasons why I have 'commentchar = ";"' in my
.gitconfig file. (Not sure if that option would be worth mentioning
in our documentation, though.)
> [...]
Ulrich
[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-25 8:17 ` Ulrich Mueller
@ 2016-01-27 4:19 ` Göktürk Yüksek
2016-01-27 7:12 ` Ulrich Mueller
0 siblings, 1 reply; 33+ messages in thread
From: Göktürk Yüksek @ 2016-01-27 4:19 UTC (permalink / raw
To: gentoo-dev
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Ulrich Mueller:
>>>>>> On Sun, 24 Jan 2016, Michael Orlitzky wrote:
>
>> The ChangeLog page is nonsense as-is, and removing it makes the
>> devmanual better. Afterwards, if someone wants to take the commit
>> message guidelines from the wiki and merge them with the old
>> ChangeLog tips, great. There's only two things worth salvaging
>> from the ChangeLog page. Here's the combined list:
>
>> 1. Everything from the Git workflow wiki page "Commit message
>> format" section.
>
> I would say not only that section, but most of the page. The
> devmanual is the one central place where our development workflow
> should be documented, not some random wiki page.
>
If the most up-to-date information is on the wiki, constantly updating
devmanual to match the wiki creates unnecessary maintenance burden.
>> 2. Mention the "Gentoo-Bug:" identifier.
>
> Right. (But had we settled for "Gentoo-Bug:"? IIRC, last time this
> was discussed there was no consensus.)
>
Related to my point above, looks like the git workflow is still in the
process of making. I expect that some discussion will continue to take
place in the future. We can always fix the other parts of the
devmanual and come back to this.
Is it possible to merge this changeset as is while the workflow
matures, or should I go for a round 3?
>> Using "bug #12345" in the commit message itself causes trouble.
>> If you word-wrap on the "#12345", it will silently clobber the
>> message.
>
> That's one of the reasons why I have 'commentchar = ";"' in my
> .gitconfig file. (Not sure if that option would be worth mentioning
> in our documentation, though.)
>
>> [...]
>
> Ulrich
>
- --
gokturk
-----BEGIN PGP SIGNATURE-----
iQEcBAEBCgAGBQJWqEU2AAoJEIT4AuXAiM4zwCAH/3q8FQB+zX0q1kuXjJfYnF3j
IvJ2uKjuHMfbSAoGy2bUGEEhsvXGpNTmLv7vDIiHILCeLR0mD1eAmWHuJjjUSmJx
PyK6kAPaXX++E5aZ9gRuXqNFSGqiNx3oPvzQs0SH6vXgVec8fpmRk6y/Dg2r20Am
hfJLPIeD8Z9Vf/0wM7EcjiS3eVYrTnYCX+aGAKpgk74zKHcnHTL9S77no0Lemby1
vlCK9ceouVd6OYdDcvjNg73umlci7JIenCZCU3nagloGwvH6XDFWdGkWSRLQ0G7T
DoZlysM2Litafjr7NgyQ7R8xp1HnR+tmWfY26urIPd4rKU+aA05kPnQiTjgKTHo=
=UDYD
-----END PGP SIGNATURE-----
^ permalink raw reply [flat|nested] 33+ messages in thread
* Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
2016-01-27 4:19 ` Göktürk Yüksek
@ 2016-01-27 7:12 ` Ulrich Mueller
0 siblings, 0 replies; 33+ messages in thread
From: Ulrich Mueller @ 2016-01-27 7:12 UTC (permalink / raw
To: gentoo-dev
[-- Attachment #1: Type: text/plain, Size: 1305 bytes --]
>>>>> On Tue, 26 Jan 2016, Göktürk Yüksek wrote:
> Ulrich Mueller:
>> The devmanual is the one central place where our development
>> workflow should be documented, not some random wiki page.
>>
> If the most up-to-date information is on the wiki, constantly
> updating devmanual to match the wiki creates unnecessary maintenance
> burden.
The point is that any information that constitutes policy should be
traceable, e.g. there should be a bug or a patch should be posted to
the mailing lists.
> Related to my point above, looks like the git workflow is still in
> the process of making. I expect that some discussion will continue
> to take place in the future. We can always fix the other parts of
> the devmanual and come back to this.
I beg to differ. Apart from some small details, things have settled.
Looking at the history of the wiki page, there was quite some activity
in the two months following the switch to git, but very little after.
> Is it possible to merge this changeset as is while the workflow
> matures, or should I go for a round 3?
I'd prefer a round 3, including Michael's suggestions at least. That
is, include the "Commit message format" subsection from the wiki page
(or even the "Commit policy" section; it is not much longer).
Ulrich
[-- Attachment #2: Type: application/pgp-signature, Size: 490 bytes --]
^ permalink raw reply [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 18/19] tools-reference: remove the echangelog page #485314
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (16 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 19/19] general-concepts/tree: remove the reference to the ChangeLog #485314 Gokturk Yuksek
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev, Michael Orlitzky
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.
X-Gentoo-Bug-URL: 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(-)
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
-<user@gentoo.org>". 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
^ permalink raw reply related [flat|nested] 33+ messages in thread
* [gentoo-dev] [PATCH v2 19/19] general-concepts/tree: remove the reference to the ChangeLog #485314
2016-01-24 8:45 [gentoo-dev] [PATCH v2 00/19] devmanual: update the docs for post git-migration Gokturk Yuksek
` (17 preceding siblings ...)
2016-01-24 8:46 ` [gentoo-dev] [PATCH v2 18/19] tools-reference: remove the echangelog page #485314 Gokturk Yuksek
@ 2016-01-24 8:46 ` Gokturk Yuksek
18 siblings, 0 replies; 33+ messages in thread
From: Gokturk Yuksek @ 2016-01-24 8:46 UTC (permalink / raw
To: devmanual; +Cc: gentoo-dev
X-Gentoo-Bug-URL: 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
^ permalink raw reply related [flat|nested] 33+ messages in thread