[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Markos Chandras]

commit:     ba2e7aa36d41c7a4e2caacd50bb2ae482934b23c
Author:     Chris Reffett <creffett <AT> gentoo <DOT> org>
AuthorDate: Sat Jan  4 02:50:18 2014 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Jan  4 19:39:59 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=ba2e7aa3

Clarify difference between _p and -r in ebuild names wrt bug 414867,
also mention the normal way of naming snapshots

---
 ebuild-writing/file-format/text.xml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 9d00e6b..cffb9e4 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -70,7 +70,7 @@ what portage considers to be the 'lowest' version comes first.
   </tr>
   <tr>
     <ti>_p</ti>
-    <ti>Patch level</ti>
+    <ti>Patch release</ti>
   </tr>
 </table>
 
@@ -98,12 +98,19 @@ No integer part of the version may be longer than 18 digits.
 Finally, version may have a Gentoo revision number in the form <c>-r1</c>. The initial
 Gentoo version should have no revision suffix, the first revision should be
 <c>-r1</c>, the second <c>-r2</c> and so on. See <uri link="::general-concepts/ebuild-revisions"/>.
+Revision numbers are distinguished from patch releases by revision bumps being
+changes by Gentoo developers, while patch releases are new releases by upstream.
 </p>
 
 <p>
 Overall, this gives us a filename like <c>libfoo-1.2.5b_pre5-r2.ebuild</c>.
 </p>
 
+<p>
+When packaging a snapshot of a source repository, the standard naming format is
+$(last-released-version)_pYYYYMMDD
+</p>
+
 </body>
 </section>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Markos Chandras]

commit:     b4972b20f9dae97f6b86d2da51f8831bce6c625e
Author:     Chris Reffett <creffett <AT> gentoo <DOT> org>
AuthorDate: Sat Jan  4 19:51:21 2014 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Jan  4 19:51:21 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=b4972b20

Further changes to ebuild naming, clarify snapshot naming scheme

---
 ebuild-writing/file-format/text.xml | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index cffb9e4..aa76952 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -99,7 +99,8 @@ Finally, version may have a Gentoo revision number in the form <c>-r1</c>. The i
 Gentoo version should have no revision suffix, the first revision should be
 <c>-r1</c>, the second <c>-r2</c> and so on. See <uri link="::general-concepts/ebuild-revisions"/>.
 Revision numbers are distinguished from patch releases by revision bumps being
-changes by Gentoo developers, while patch releases are new releases by upstream.
+changes by Gentoo developers, while patch releases are new releases by upstream (with the exception
+of snapshots, see below).
 </p>
 
 <p>
@@ -107,8 +108,11 @@ Overall, this gives us a filename like <c>libfoo-1.2.5b_pre5-r2.ebuild</c>.
 </p>
 
 <p>
-When packaging a snapshot of a source repository, the standard naming format is
-$(last-released-version)_pYYYYMMDD
+When packaging a snapshot of a source repository, there are two commonly used formats. The first
+treats the snapshot as a patch to the previous version, and so the ebuild version is in the format
+$(last-released-version)_pYYYYMMDD. Alternatively, the snapshot may be treated as a pre-release to
+an upcoming version, usually used when a release is anticipated but not out yet. The format for this
+is $(upcoming-version)_preYYYYMMDD.
 </p>
 
 </body>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Markos Chandras]

commit:     b4972b20f9dae97f6b86d2da51f8831bce6c625e
Author:     Chris Reffett <creffett <AT> gentoo <DOT> org>
AuthorDate: Sat Jan  4 19:51:21 2014 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Jan  4 19:51:21 2014 +0000
URL:        http://sources.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=b4972b20

Further changes to ebuild naming, clarify snapshot naming scheme

---
 ebuild-writing/file-format/text.xml | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index cffb9e4..aa76952 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -99,7 +99,8 @@ Finally, version may have a Gentoo revision number in the form <c>-r1</c>. The i
 Gentoo version should have no revision suffix, the first revision should be
 <c>-r1</c>, the second <c>-r2</c> and so on. See <uri link="::general-concepts/ebuild-revisions"/>.
 Revision numbers are distinguished from patch releases by revision bumps being
-changes by Gentoo developers, while patch releases are new releases by upstream.
+changes by Gentoo developers, while patch releases are new releases by upstream (with the exception
+of snapshots, see below).
 </p>
 
 <p>
@@ -107,8 +108,11 @@ Overall, this gives us a filename like <c>libfoo-1.2.5b_pre5-r2.ebuild</c>.
 </p>
 
 <p>
-When packaging a snapshot of a source repository, the standard naming format is
-$(last-released-version)_pYYYYMMDD
+When packaging a snapshot of a source repository, there are two commonly used formats. The first
+treats the snapshot as a patch to the previous version, and so the ebuild version is in the format
+$(last-released-version)_pYYYYMMDD. Alternatively, the snapshot may be treated as a pre-release to
+an upcoming version, usually used when a release is anticipated but not out yet. The format for this
+is $(upcoming-version)_preYYYYMMDD.
 </p>
 
 </body>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Markos Chandras]

commit:     ba2e7aa36d41c7a4e2caacd50bb2ae482934b23c
Author:     Chris Reffett <creffett <AT> gentoo <DOT> org>
AuthorDate: Sat Jan  4 02:50:18 2014 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Jan  4 19:39:59 2014 +0000
URL:        http://sources.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=ba2e7aa3

Clarify difference between _p and -r in ebuild names wrt bug 414867,
also mention the normal way of naming snapshots

---
 ebuild-writing/file-format/text.xml | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 9d00e6b..cffb9e4 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -70,7 +70,7 @@ what portage considers to be the 'lowest' version comes first.
   </tr>
   <tr>
     <ti>_p</ti>
-    <ti>Patch level</ti>
+    <ti>Patch release</ti>
   </tr>
 </table>
 
@@ -98,12 +98,19 @@ No integer part of the version may be longer than 18 digits.
 Finally, version may have a Gentoo revision number in the form <c>-r1</c>. The initial
 Gentoo version should have no revision suffix, the first revision should be
 <c>-r1</c>, the second <c>-r2</c> and so on. See <uri link="::general-concepts/ebuild-revisions"/>.
+Revision numbers are distinguished from patch releases by revision bumps being
+changes by Gentoo developers, while patch releases are new releases by upstream.
 </p>
 
 <p>
 Overall, this gives us a filename like <c>libfoo-1.2.5b_pre5-r2.ebuild</c>.
 </p>
 
+<p>
+When packaging a snapshot of a source repository, the standard naming format is
+$(last-released-version)_pYYYYMMDD
+</p>
+
 </body>
 </section>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     6ac73286eed9f764cd4bf24ce755389781c2403b
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Apr 15 06:41:39 2015 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Apr 15 06:41:39 2015 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6ac73286

Update link to IEEE Std 1003.1.

Thanks to Brian Haslett for pointing this out.

 ebuild-writing/file-format/text.xml | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index de2380a..6fed594 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -25,9 +25,11 @@ discouraged, but technically valid.
 </p>
 
 <note>
-This is the same as <uri link="http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_276">
-IEEE1003.1-2004-3.276</uri>, with the exception of the period character and with the
-addition of the plus character to keep GTK+ and friends happy.
+This is the same as
+<uri link="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278">
+IEEE Std 1003.1-2013, section 3.278</uri>, with the exception of the period
+character and with the addition of the plus character to keep GTK+ and friends
+happy.
 </note>
 
 <p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     43afeef731e1c1bfee0615c8257e5a75f715ce05
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sun May  3 17:08:15 2015 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun May  3 17:08:15 2015 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=43afeef7

Merge sentence about 9999 naming policy from Developer Handbook.

This is taken from proj/en/devrel/handbook/hb-policy-ebuild.xml,
section "Ebuild policy", subsection "CVS sources policy".

Original author: hwoarang

 ebuild-writing/file-format/text.xml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 6fed594..1e1f59c 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -117,6 +117,12 @@ an upcoming version, usually used when a release is anticipated but not out yet.
 is $(upcoming-version)_preYYYYMMDD.
 </p>
 
+<p>
+The policy for so-called <e>live</e> ebuilds
+(see <uri link="::ebuild-writing/functions/src_unpack/#src_unpack-actions"/>)
+is to use <c>9999</c> as the version (or as the last version component).
+</p>
+
 </body>
 </section>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Justin Lecher]

commit:     5969315c9dc0f0deebeaa94ae6843250b6fc2e40
Author:     Viktor Lazarev <taurus101v <AT> gmail <DOT> com>
AuthorDate: Sat Aug  8 19:22:27 2015 +0000
Commit:     Justin Lecher <jlec <AT> gentoo <DOT> org>
CommitDate: Sat Aug  8 19:22:27 2015 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5969315c

Update bash command

Using of `$(portageq portdir)/header.txt` throws warning:
> WARNING: 'portageq portdir' is deprecated. Use the get_repo_path command instead. eg: 'portageq get_repo_path / gentoo' instead.

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 6ab22a2..b71ee74 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -138,7 +138,7 @@ 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 portdir)/header.txt</c>. Ensure that the <c>$Header: $</c> line is not
+<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.
 </p>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Göktürk Yüksek]

commit:     085453777057ec395d069ff274ba67ae04b77e05
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Thu Nov  3 13:29:35 2016 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Thu Nov  3 15:24:05 2016 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=08545377

ebuild-writing/file-format: Fix missing <c/> style around _p suffix

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index e74fd15..3352e90 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -76,7 +76,7 @@ what portage considers to be the 'lowest' version comes first.
     <ti>Normal release</ti>
   </tr>
   <tr>
-    <ti>_p</ti>
+    <ti><c>_p</c></ti>
     <ti>Patch release</ti>
   </tr>
 </table>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Göktürk Yüksek]

commit:     9486c65020e2ddf58b8d09df9778f83b8a57ac34
Author:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Tue Nov 22 05:43:44 2016 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Tue Nov 22 05:44:51 2016 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9486c650

ebuild-writing/file-format: add a reference to versionator.eclass #460028

 ebuild-writing/file-format/text.xml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 3352e90..39e2ba4 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -128,6 +128,13 @@ The policy for so-called <e>live</e> ebuilds
 is to use <c>9999</c> as the version (or as the last version component).
 </p>
 
+<p>
+The
+<uri link="::eclass-reference/versionator.eclass">
+versionator.eclass</uri> may be used to manipulate and extract ebuild
+version components.
+</p>
+
 </body>
 </section>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     2aed99e2d0d660162cf4d4aa436247bbf4c1559d
Author:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
AuthorDate: Wed Mar  1 21:28:29 2017 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Mar  3 05:53:59 2017 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2aed99e2

ebuild-writing/file-format: use the gitweb link for header.txt

Amended: Mention that the header must be followed by an empty line.

 ebuild-writing/file-format/text.xml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 1717d27..754b81e 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -144,8 +144,10 @@ version components.
 
 <p>
 All ebuilds committed to the tree should have a two 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>.
+the start indicating copyright, followed by an empty line. This must be an
+exact copy of the contents of
+<c><uri link="https://gitweb.gentoo.org/repo/gentoo.git/tree/header.txt">
+header.txt</uri></c> in the top directory of the Gentoo repository.
 </p>
 
 <codesample lang="ebuild">

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     a111caea919770d5dba7a6316e9001691cd04342
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri Oct 27 20:57:19 2017 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Nov 12 20:36:03 2017 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a111caea

ebuild-writing/file-format: Describe syntax of suffixes correctly.

Version suffixes _alpha, _beta, etc. can be followed by an unsigned
integer, including zero.
PMS reference: https://projects.gentoo.org/pms/6/pms.html#x1-300003.2

Bug: https://bugs.gentoo.org/635630

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 56758f1..5f2bf93 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -82,7 +82,7 @@ what portage considers to be the 'lowest' version comes first.
 </table>
 
 <p>
-Any of these suffixes may be followed by a non-zero positive integer.
+Any of these suffixes may be followed by an unsigned integer.
 </p>
 
 <p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     bfacfb2f4df9e3ef5e2b8c3814d7093f35e6e2a9
Author:     Andrey Utkin <andrey_utkin <AT> gentoo <DOT> org>
AuthorDate: Mon Jun 17 18:39:24 2019 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Jun 23 18:12:08 2019 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=bfacfb2f

ebuild-writing/file-format: add IEEE Std section name

Call the section by name.

This makes it possible to understand what is being referenced without
following the link.

This also makes sure if number of the section changes again, we won't
miss the discrepancy.

Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/98
Signed-off-by: Andrey Utkin <andrey_utkin <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index acc5d9a..f9e4bd9 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -27,9 +27,9 @@ discouraged, but technically valid.
 <note>
 This is the same as
 <uri link="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282">
-IEEE Std 1003.1-2013, section 3.282</uri>, with the exception of the period
-character and with the addition of the plus character to keep GTK+ and friends
-happy.
+IEEE Std 1003.1-2013, section 3.282 (Portable Filename Character Set)</uri>,
+with the exception of the period character and with the addition of the plus
+character to keep GTK+ and friends happy.
 </note>
 
 <p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     3509c4277762e8beff3d0452316cf85f21f7f5eb
Author:     Andrey Utkin <andrey_utkin <AT> gentoo <DOT> org>
AuthorDate: Mon Jun 17 17:27:54 2019 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Jun 23 18:11:38 2019 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3509c427

ebuild-writing/file-format: correct IEEE Std section number

The existing reference pointed at "Pipe" definition, while 3.282 defines
"Portable Filename Character Set" which apparently is the intended
reference.

Signed-off-by: Andrey Utkin <andrey_utkin <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 912ae98..acc5d9a 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -26,8 +26,8 @@ discouraged, but technically valid.
 
 <note>
 This is the same as
-<uri link="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_278">
-IEEE Std 1003.1-2013, section 3.278</uri>, with the exception of the period
+<uri link="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282">
+IEEE Std 1003.1-2013, section 3.282</uri>, with the exception of the period
 character and with the addition of the plus character to keep GTK+ and friends
 happy.
 </note>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     87ea31e871d19af32750bdd187a84589cffd329b
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 24 12:10:05 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 24 12:10:05 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=87ea31e8

ebuild-writing/file-format: New subsection for binary packages.

Discussion reference:
https://archives.gentoo.org/gentoo-dev/message/8dadfbd3c15b6580abb84882e9115a47
and replies.

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 16d857e..5eb0cf8 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -140,6 +140,27 @@ The policy for so-called <e>live</e> ebuilds
 is to use <c>9999</c> as the version (or as the last version component).
 </p>
 
+</body>
+</subsection>
+
+<subsection>
+<title>Binary packages</title>
+<body>
+
+<p>
+Gentoo usually builds its packages from source. Exceptionally, a binary package
+can be provided instead (e.g., if upstream does not provide a source).
+Such packages should still follow normal naming conventions and do not need any
+special suffix.
+</p>
+
+<p>
+If a binary package is provided in addition to its open-source based
+equivalent, the name of the former should be suffixed with <c>-bin</c>
+if necessary for distinction. Examples are packages that are heavy on resources
+like CPU time or memory when being built from source.
+</p>
+
 </body>
 </subsection>
 </section>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     e9ac0b66c0158ecfe6c0f142e5afc4c38c8b9e46
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 24 12:08:17 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 24 12:08:17 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e9ac0b66

ebuild-writing/file-format: Move snapshots and live ebuilds into subsection.

Move paragraph about version commands and update it.

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index e899f7b..16d857e 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -114,6 +114,18 @@ of snapshots, see below).
 Overall, this gives us a filename like <c>libfoo-1.2.5b_pre5-r2.ebuild</c>.
 </p>
 
+<p>
+The <uri link ="::ebuild-writing/variables/#Version and Name Formatting Issues">
+EAPI 7 version commands</uri> may be used to manipulate and extract
+ebuild version components.
+</p>
+
+</body>
+
+<subsection>
+<title>Snapshots and live ebuilds</title>
+<body>
+
 <p>
 When packaging a snapshot of a source repository, there are two commonly used formats. The first
 treats the snapshot as a patch to the previous version, and so the ebuild version is in the format
@@ -128,14 +140,8 @@ The policy for so-called <e>live</e> ebuilds
 is to use <c>9999</c> as the version (or as the last version component).
 </p>
 
-<p>
-The
-<uri link="::eclass-reference/eapi7-ver.eclass">
-eapi7-ver.eclass</uri> may be used to manipulate and extract ebuild
-version components.
-</p>
-
 </body>
+</subsection>
 </section>
 
 <section>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     7c7230a24f8c1c77e262de5edb4851f76098e515
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:18:51 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 07:31:20 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7c7230a2

ebuild-writing/file-format: drop ChangeLog reference

Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index e5c3fd3..ff738c2 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -221,7 +221,7 @@ positions wide, and multibyte characters are just one position wide.
 <title>Character Set</title>
 <body>
 <p>
-All ebuilds (and eclasses, metadata files and ChangeLogs) must use the
+All ebuilds (and eclasses, metadata files, etc.) must use the
 UTF-8 character set.
 See <uri link="https://www.gentoo.org/glep/glep-0031.html">GLEP 31</uri>
 for details.

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     15e584879453707f3ffdd5ec94dc9f2a10a8832a
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:21:22 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 07:31:21 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=15e58487

ebuild-writing/file-format: mention 99999999 as live for YYYYMMDD versions

Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index ff738c2..bd87629 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -137,7 +137,9 @@ is $(upcoming-version)_preYYYYMMDD.
 <p>
 The policy for so-called <e>live</e> ebuilds
 (see <uri link="::ebuild-writing/functions/src_unpack/#src_unpack Actions"/>)
-is to use <c>9999</c> as the version (or as the last version component).
+is to use <c>9999</c> as the version (or as the last version component). For
+packages with more than 4 digits e.g. YYYYMMDD format, <c>99999999</c> is an
+acceptable alternative.
 </p>
 
 </body>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     1ab1fefd268081d28fe137ab50732634935b79c0
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:22:54 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:00:52 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=1ab1fefd

ebuild-writing/file-format: mention pkgdev

Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 8a8271e..65adca6 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -205,9 +205,9 @@ indenting, never inside strings.
 </p>
 
 <p>
-Avoid trailing whitespace: <c>repoman</c> will warn you about this if your
-ebuild contains trailing or leading whitespace (whitespace instead of
-tabs for indentation) when you commit.
+Avoid trailing whitespace: <c>repoman</c> or <c>pkgcheck</c> will warn you about
+this if your ebuild contains trailing or leading whitespace (whitespace instead
+of tabs for indentation) when you commit.
 </p>
 
 <p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     91d763c234ba012d9fdbd31e778066918018ec9f
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Mar 21 04:22:21 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 30 16:00:51 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=91d763c2

ebuild-writing/file-format: <c> repoman

Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index bd87629..8a8271e 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -205,7 +205,7 @@ indenting, never inside strings.
 </p>
 
 <p>
-Avoid trailing whitespace: repoman will warn you about this if your
+Avoid trailing whitespace: <c>repoman</c> will warn you about this if your
 ebuild contains trailing or leading whitespace (whitespace instead of
 tabs for indentation) when you commit.
 </p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Sam James]

commit:     c11712867f71a9c7ece52c31444b26a59e9873d1
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Aug  1 02:18:20 2021 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sat Aug 14 01:46:14 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c1171286

ebuild-writing/file-format: link to PMS for version specification

Signed-off-by: Sam James <sam <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index 65adca6..d9b0758 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -120,6 +120,14 @@ EAPI 7 version commands</uri> may be used to manipulate and extract
 ebuild version components.
 </p>
 
+<p>
+The formal specification of version
+<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-250003.2">
+format</uri> and the comparison
+<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-260003.3">
+algorithm</uri> can be found in PMS.
+</p>
+
 </body>
 
 <subsection>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Sam James]

commit:     969156f60e46ca8fd299c38483a42f9776047a1c
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sun Aug  1 02:53:35 2021 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Sat Aug 14 01:46:15 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=969156f6

ebuild-writing/file-format: rewrap long paragraph

Signed-off-by: Sam James <sam <AT> gentoo.org>
Closes: https://github.com/gentoo/devmanual/pull/242
Signed-off-by: Sam James <sam <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index d9b0758..0065b22 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -135,11 +135,12 @@ algorithm</uri> can be found in PMS.
 <body>
 
 <p>
-When packaging a snapshot of a source repository, there are two commonly used formats. The first
-treats the snapshot as a patch to the previous version, and so the ebuild version is in the format
-$(last-released-version)_pYYYYMMDD. Alternatively, the snapshot may be treated as a pre-release to
-an upcoming version, usually used when a release is anticipated but not out yet. The format for this
-is $(upcoming-version)_preYYYYMMDD.
+When packaging a snapshot of a source repository, there are two commonly used
+formats. The first treats the snapshot as a patch to the previous version, and
+so the ebuild version is in the format $(last-released-version)_pYYYYMMDD.
+Alternatively, the snapshot may be treated as a pre-release to an upcoming
+version, usually used when a release is anticipated but not out yet. The format
+for this is $(upcoming-version)_preYYYYMMDD.
 </p>
 
 <p>

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Joonas Niilola]

commit:     81fd4e9f4762cb08344a1b8e1bf147e816129543
Author:     Joonas Niilola <juippis <AT> gentoo <DOT> org>
AuthorDate: Thu Jan 12 11:26:54 2023 +0000
Commit:     Joonas Niilola <juippis <AT> gentoo <DOT> org>
CommitDate: Thu Jan 12 11:26:54 2023 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=81fd4e9f

ebuild-writing/file-format: update copyright header's year to 2023

 - since some people get it from this file.

Signed-off-by: Joonas Niilola <juippis <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index ca41803..63b7f5e 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -189,7 +189,7 @@ header.txt</uri></c> in the top directory of the Gentoo repository.
 </p>
 
 <codesample lang="ebuild">
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2023 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 </codesample>
 

[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/

[Ulrich Müller]

commit:     c39ea4df4ce10b373177276ddc3bdfb1d4c26a3c
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Feb 21 07:47:37 2024 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Feb 21 07:47:37 2024 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c39ea4df

ebuild-writing/file-format: Update year in ebuild header

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/file-format/text.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
index ff7fb91..3772554 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -190,7 +190,7 @@ header.txt</uri></c> in the top directory of the Gentoo repository.
 </p>
 
 <codesample lang="ebuild">
-# Copyright 1999-2023 Gentoo Authors
+# Copyright 1999-2024 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 </codesample>