From: "Justin Lecher" <jlec@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/, ebuild-writing/using-eclasses/, ...
Date: Thu, 20 Aug 2015 07:06:36 +0000 (UTC) [thread overview]
Message-ID: <1440015513.d5175b92723f77d8a7899df887159b9a5fa1bda3.jlec@gentoo> (raw)
commit: d5175b92723f77d8a7899df887159b9a5fa1bda3
Author: Johannes Huber <johu <AT> gentoo <DOT> org>
AuthorDate: Wed Aug 19 20:18:33 2015 +0000
Commit: Justin Lecher <jlec <AT> gentoo <DOT> org>
CommitDate: Wed Aug 19 20:18:33 2015 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d5175b92
Update header lines
Due to git migration.
ebuild-writing/common-mistakes/text.xml | 14 ++++++--------
ebuild-writing/eapi/text.xml | 12 ++++++------
ebuild-writing/file-format/text.xml | 8 ++++----
ebuild-writing/functions/src_prepare/epatch/text.xml | 12 ++++++------
ebuild-writing/functions/src_unpack/rpm-sources/text.xml | 4 ++--
ebuild-writing/using-eclasses/text.xml | 4 ++--
eclass-writing/text.xml | 12 ++++++------
7 files changed, 32 insertions(+), 34 deletions(-)
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index 9c6b423..1718d55 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -150,8 +150,7 @@ Removing "-Werror" from configure.ac can cause breakage in very rare cases where
<p>
When you submit your ebuilds, the header should be <e>exactly</e> the same as
the one in <path>/usr/portage/skel.ebuild</path>. Most importantly, do not
-modify it in any way and make sure that the <c>$Header: $</c> line is
-intact.
+modify it in any way and make sure that the <c>$Id$</c> line is intact.
</p>
<p>
@@ -159,17 +158,16 @@ The first three lines <e>must</e> look like this:
</p>
<pre caption="Valid Header">
-# Copyright 1999-2004 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
</pre>
<p>
Only if you are submitting a patched or version bumped ebuild, should you not
-need to modify the <c>$Header: $</c> line. But the line must be present.
-When we check the ebuild into CVS, it will modify that header with the
-appropriate version and date information. So there is no need for you to
-manually modify it.
+need to modify the <c>$Id$</c> line. But the line must be present.
+It will be expanded on the staging box automatically. So there is no need for you to manually modify it.
+See <uri link="::general-concepts/git-to-rsync"/>.
</p>
</body>
diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 3faab22..6d0162a 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -42,9 +42,9 @@ Most developers prefer to set the EAPI version without quotes. However, the PMS
</note>
<codesample lang="ebuild">
-# Copyright 1999-2013 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
EAPI=5
inherit eutils
@@ -120,9 +120,9 @@ src_compile() {
</important>
<codesample lang="ebuild">
-# Copyright 1999-2010 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
EAPI=1
@@ -515,9 +515,9 @@ DEPEND="
</p>
<p>Example:</p>
<codesample lang="ebuild">
-# Copyright 1999-2009 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
EAPI=4
inherit linux-info
diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index b71ee74..74a623e 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -138,14 +138,14 @@ is to use <c>9999</c> as the version (or as the last version component).
<p>
All ebuilds committed to the tree should have a three line header immediately at
the start indicating copyright. This must be an exact copy of the contents of
-<c>$(portageq get_repo_path / gentoo)/header.txt</c>. Ensure that the <c>$Header: $</c> line is not
-modified manually <d/> CVS will handle this line specially.
+<c>$(portageq get_repo_path / gentoo)/header.txt</c>. Ensure that the <c>$Id$</c> line is not
+modified manually <d/> will be expanded on staging box. See <uri link="::general-concepts/git-to-rsync"/>.
</p>
<codesample lang="ebuild">
-# Copyright 1999-2006 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
</codesample>
</body>
diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml b/ebuild-writing/functions/src_prepare/epatch/text.xml
index 91d869e..2401bdc 100644
--- a/ebuild-writing/functions/src_prepare/epatch/text.xml
+++ b/ebuild-writing/functions/src_prepare/epatch/text.xml
@@ -66,14 +66,14 @@ Remember to add the patch to <c>SRC_URI</c>.
</body>
<subsection>
-<title>CVS Keyword Lines and Patches</title>
+<title>Git Keyword Expansion Lines and Patches</title>
<body>
<p>
-If your patch includes any changes to CVS <c>$Id: $</c>
-(or <c>$Header: $</c>, or <c>$Date: $</c>) lines, it cannot be
-distributed under <c>files/</c>, since CVS will clobber the patch when
-you commit. In these situations, either remove this hunk of the patch
-manually, or mirror the file.
+If your patch includes any changes to Git <c>$Id$</c>
+(or <c>$Date$</c>) lines, it cannot be
+distributed under <c>files/</c>, since Git will clobber the patch when
+keywords are expanded on the staging box. In these situations, either remove this hunk of the patch
+manually, or mirror the file. See <uri link="::general-concepts/git-to-rsync"/>.
</p>
</body>
</subsection>
diff --git a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
index dcf9113..0ff0def 100644
--- a/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
+++ b/ebuild-writing/functions/src_unpack/rpm-sources/text.xml
@@ -52,9 +52,9 @@ patches. The filename should be <c>suse-fetchmail-6.2.5.54.1.ebuild</c>.
</p>
<codesample lang="ebuild">
-# Copyright 1999-2005 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
inherit eutils versionator rpm
diff --git a/ebuild-writing/using-eclasses/text.xml b/ebuild-writing/using-eclasses/text.xml
index 503ce34..d10f4fc 100644
--- a/ebuild-writing/using-eclasses/text.xml
+++ b/ebuild-writing/using-eclasses/text.xml
@@ -30,9 +30,9 @@ After inheriting an eclass, its provided functions can be used as normal. Here's
</p>
<codesample lang="ebuild">
-# Copyright 1999-2010 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
EAPI=2
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml
index 1914448..63aaf9c 100644
--- a/eclass-writing/text.xml
+++ b/eclass-writing/text.xml
@@ -176,9 +176,9 @@ a single function, <c>domacosapp</c>.
</p>
<codesample lang="ebuild">
-# Copyright 1999-2005 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
#
# Original Author: Ciaran McCreesh <ciaranm@gentoo.org>
@@ -263,9 +263,9 @@ something like the following:
</p>
<codesample lang="ebuild">
-# Copyright 1999-2005 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
# Original Author: Ciaran McCreesh <ciaranm@gentoo.org>
# Purpose: Demonstration of EXPORT_FUNCTIONS. Defines simple wrappers for the
@@ -306,9 +306,9 @@ for an eclass to invoke die from the global scope. For example:
</p>
<codesample lang="ebuild">
-# Copyright 1999-2010 Gentoo Foundation
+# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# $Header: $
+# $Id$
# Purpose: Demonstration of die upon invalid EAPI usage.
reply other threads:[~2015-08-20 7:06 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1440015513.d5175b92723f77d8a7899df887159b9a5fa1bda3.jlec@gentoo \
--to=jlec@gentoo.org \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox