public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/, ebuild-writing/eapi/, ...
@ 2020-01-23  7:47 Ulrich Müller
  0 siblings, 0 replies; only message in thread
From: Ulrich Müller @ 2020-01-23  7:47 UTC (permalink / raw
  To: gentoo-commits

commit:     5a946b416b447318fc092c0e3b320d5a8f88833e
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Mon Jan 20 17:26:47 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Jan 23 00:01:02 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5a946b41

ebuild-writing/eapi: Move EAPI=3 information to other sections.

- Prefix support: Reference to Prefix documentation moved to
  ebuild-writing/variables
- unpack .xz support: Add list of recognized unpack formats in
  ebuild-writing/functions/src_unpack

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

 ebuild-writing/eapi/text.xml                 | 26 -------------------
 ebuild-writing/functions/src_unpack/text.xml | 39 ++++++++++++++++++++++++++++
 ebuild-writing/variables/text.xml            |  2 ++
 general-concepts/dependencies/text.xml       |  5 +---
 4 files changed, 42 insertions(+), 30 deletions(-)

diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 048284f..89b88ff 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -62,32 +62,6 @@ is the best.  Using the features of the latest EAPI is encouraged.
 </body>
 </section>
 
-<section>
-<title>EAPI=3</title>
-<body>
-
-<ul>
-	<li>
-		<p><b>Gentoo Prefix support</b></p>
-		<p>
-			Support for the <c>EPREFIX</c>, <c>EROOT</c>, and <c>ED</c>
-			variables. If an ebuild uses one of these, it must be EAPI3 aware.
-			See <uri link="https://wiki.gentoo.org/wiki/Project:Prefix/Technical_Documentation">
-			Gentoo Prefix Technical Documentation</uri> for more information.
-		</p>
-	</li>
-	<li>
-		<p><b>unpack supports .xz and .tar.xz</b></p>
-		<p>
-			The <c>unpack</c> command supports xz-archives and xz-compressed tar
-			files.
-		</p>
-	</li>
-</ul>
-
-</body>
-</section>
-
 <section>
 <title>EAPI=4</title>
 

diff --git a/ebuild-writing/functions/src_unpack/text.xml b/ebuild-writing/functions/src_unpack/text.xml
index aad45f6..862a41e 100644
--- a/ebuild-writing/functions/src_unpack/text.xml
+++ b/ebuild-writing/functions/src_unpack/text.xml
@@ -72,6 +72,45 @@ usually simpler to avoid working with <c>${A}</c>.
 </body>
 </section>
 
+<section>
+<title>Known file formats</title>
+<body>
+
+<p>
+The <c>unpack</c> function recognizes the following file formats:
+</p>
+
+<ul>
+  <li><c>*.tar</c></li>
+  <li>
+    <c>*.gz</c>, <c>*.Z</c>,
+    <c>*.tar.gz</c>, <c>*.tgz</c>, <c>*.tar.Z</c>
+  </li>
+  <li>
+    <c>*.bz2</c>, <c>*.bz</c>,
+    <c>*.tar.bz2</c>, <c>*.tbz2</c>, <c>*.tar.bz</c>, <c>*.tbz</c>
+  </li>
+  <li><c>*.lzma</c>, <c>*.tar.lzma</c></li>
+  <li><c>*.xz</c>, <c>*.tar.xz</c>, <c>*.txz</c></li>
+  <li><c>*.zip</c>, <c>*.ZIP</c>, <c>*.jar</c></li>
+  <li><c>*.a</c>, <c>*.deb</c></li>
+  <li><c>*.7z</c>, <c>*.7Z</c></li>
+  <li><c>*.rar</c>, <c>*.RAR</c></li>
+  <li><c>*.LHA</c>, <c>*.LHa</c>, <c>*.lha</c>, <c>*.lzh</c></li>
+</ul>
+
+<p>
+In EAPI 6 and later, filename extensions are matched case-insensitively.
+</p>
+
+<important>
+Unless the utility needed for unpacking is in the system set, the ebuild must
+specify the necessary build time dependency for it.
+</important>
+
+</body>
+</section>
+
 <section>
 <title><c>src_unpack</c> Actions</title>
 <body>

diff --git a/ebuild-writing/variables/text.xml b/ebuild-writing/variables/text.xml
index 66a9822..81d4c44 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -117,6 +117,8 @@ for these variables when writing ebuilds.
     <ti><c>EPREFIX</c></ti>
     <ti>
       The normalised offset-prefix path of an offset installation.
+      See <uri link="https://wiki.gentoo.org/wiki/Project:Prefix/Technical_Documentation">
+      Gentoo Prefix Technical Documentation</uri> for more information.
     </ti>
   </tr>
   <tr>

diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml
index 7992571..32feff1 100644
--- a/general-concepts/dependencies/text.xml
+++ b/general-concepts/dependencies/text.xml
@@ -32,10 +32,7 @@ exemptions).
 <p>
 The <c>RDEPEND</c> ebuild variable should specify any dependencies which are
 required at runtime. This includes libraries (when dynamically linked), any data
-packages and (for interpreted languages) the relevant interpreter. In EAPI=3 or
-older, if this variable is not specified it defaults to the value of
-<c>DEPEND</c>, however the implicit usage is frowned upon. In EAPI=4, the
-implicit behaviour was removed and the assignment is always explicit.
+packages and (for interpreted languages) the relevant interpreter.
 </p>
 
 <p>


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2020-01-23  7:47 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-01-23  7:47 [gentoo-commits] proj/devmanual:master commit in: general-concepts/dependencies/, ebuild-writing/eapi/, Ulrich Müller

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