public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2021-12-09  4:24 Sam James
  0 siblings, 0 replies; 7+ messages in thread
From: Sam James @ 2021-12-09  4:24 UTC (permalink / raw
  To: gentoo-commits

commit:     d9e28f40be32f76224ef0dbe2f3163e0615896f1
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Thu Dec  9 04:19:23 2021 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Thu Dec  9 04:24:29 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d9e28f40

general-concepts/autotools: use EAPI 8 in examples and autotools.eclass helpers

- Use EAPI 8 in examples
- Use eaclocal, eautoconf
- Define WANT_AUTOCONF/WANT_AUTOMAKE in global scope before inheriting
  autotools.eclass. The eclass declares these as @PRE_INHERIT which
  is necessary for e.g. ensuring dependencies are set.

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

 general-concepts/autotools/text.xml | 45 ++++++++++++++++++++++++++-----------
 1 file changed, 32 insertions(+), 13 deletions(-)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index b7170ba..11cacf3 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -116,23 +116,28 @@ either <c>Makefile.am</c> or <c>configure.ac</c>:
 </p>
 
 <codesample lang="ebuild">
-EAPI=5
+EAPI=8
 
+WANT_AUTOCONF=2.5
+WANT_AUTOMAKE=1.9
 inherit autotools
 
+IUSE="nls"
+
+BDEPEND="nls? ( sys-devel/gettext )"
+
 src_prepare() {
+	default
+
 	# Remove problematic LDFLAGS declaration
 	sed -i -e '/^LDFLAGS/d' src/Makefile.am || die
 
 	# Rerun autotools
-	einfo "Regenerating autotools files..."
-	WANT_AUTOCONF=2.5 eautoconf
-	WANT_AUTOMAKE=1.9 eautomake
+	eautoreconf
 }
 
-src_compile() {
+src_configure() {
 	econf $(use_enable nls)
-	emake
 }
 </codesample>
 
@@ -591,10 +596,17 @@ In the first case you usually want to do something like:
 </p>
 
 <codesample lang="ebuild">
-einfo "Regenerating autotools files..."
-cp "${WORKDIR}/gentoo-m4" "${S}/m4" || die "m4 copy failed"
-WANT_AUTOCONF="2.5" aclocal -I "${S}/m4" || die "aclocal failed"
-WANT_AUTOCONF="2.5" autoconf || die "autoconf failed"
+WANT_AUTOCONF="2.5"
+inherit autotools
+
+src_prepare() {
+	default
+
+	einfo "Regenerating autotools files..."
+	cp "${WORKDIR}/gentoo-m4" "${S}/m4" || die "m4 copy failed"
+	eaclocal -I "${S}/m4"
+	eautoconf
+}
 </codesample>
 
 <p>
@@ -602,9 +614,16 @@ and so on. In the second case you can simplify it in this way:
 </p>
 
 <codesample lang="ebuild">
-einfo "Regenerating autotools files..."
-WANT_AUTOCONF="2.5" aclocal -I "${WORKDIR}/gentoo-m4" || die "aclocal failed"
-WANT_AUTOCONF="2.5" autoconf || die "autoconf failed"
+WANT_AUTOCONF="2.5"
+inherit autotools
+
+src_prepare() {
+	default
+
+	einfo "Regenerating autotools files..."
+	eaclocal -I "${WORKDIR}/gentoo-m4"
+	eautoconf
+}
 </codesample>
 
 <p>


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2022-03-01  9:59 Sam James
  0 siblings, 0 replies; 7+ messages in thread
From: Sam James @ 2022-03-01  9:59 UTC (permalink / raw
  To: gentoo-commits

commit:     6756801c7f1d3b8a6326567a164891333b1f10d3
Author:     Thomas Bracht Laumann Jespersen <t <AT> laumann <DOT> xyz>
AuthorDate: Thu Jan 27 09:39:43 2022 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Tue Mar  1 09:58:56 2022 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6756801c

general-concepts/autotools: Remove comment re einfo

In commit d9e28f40be32f76224ef0dbe2f3163e0615896f1, einfo lines were
removed from the examples but a paragraph still still referenced it.
Delete the paragraph.

Closes: https://bugs.gentoo.org/832156
Signed-off-by: Thomas Bracht Laumann Jespersen <t <AT> laumann.xyz>
Signed-off-by: Sam James <sam <AT> gentoo.org>

 general-concepts/autotools/text.xml | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 11cacf3..c4abdd4 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -141,13 +141,6 @@ src_configure() {
 }
 </codesample>
 
-<p>
-The <c>einfo</c> message before running autotools is not mandatory. However, these
-steps can sometimes take a while and may produce no output, so it may make sense
-to let the user know that something is still happening. See
-<uri link="::ebuild-writing/messages"/>.
-</p>
-
 </body>
 </section>
 


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2020-01-27 19:58 Ulrich Müller
  0 siblings, 0 replies; 7+ messages in thread
From: Ulrich Müller @ 2020-01-27 19:58 UTC (permalink / raw
  To: gentoo-commits

commit:     75810c694c5479cc245e71e7fd0b0937d8c78821
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Jan 25 17:13:45 2020 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Mon Jan 27 19:57:02 2020 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=75810c69

general-concepts/autotools/diagram.svg: Delete obsolete configure.in.

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

 general-concepts/autotools/diagram.svg | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/general-concepts/autotools/diagram.svg b/general-concepts/autotools/diagram.svg
index 37e5a93..3ecea41 100644
--- a/general-concepts/autotools/diagram.svg
+++ b/general-concepts/autotools/diagram.svg
@@ -267,14 +267,9 @@
      width="80"
      y="80"
      x="140" />
-  <text
-     id="text69"
-     y="93"
-     x="180"
-     style="text-anchor:middle;-inkscape-font-specification:'Open Sans';font-family:'Open Sans';font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;">configure.in /</text>
   <text
      id="text71"
-     y="105"
+     y="99"
      x="180"
      style="text-anchor:middle;-inkscape-font-specification:'Open Sans';font-family:'Open Sans';font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;">configure.ac</text>
   <line


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2018-06-14 18:43 Göktürk Yüksek
  0 siblings, 0 replies; 7+ messages in thread
From: Göktürk Yüksek @ 2018-06-14 18:43 UTC (permalink / raw
  To: gentoo-commits

commit:     c4df53132e81e885635da2f326bb9b6afde78964
Author:     Mikle Kolyada <zlogene <AT> gentoo <DOT> org>
AuthorDate: Thu May 24 18:27:54 2018 +0000
Commit:     Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
CommitDate: Thu Jun 14 18:39:14 2018 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c4df5313

general-concepts/autotools: Add Autotools Mythbuster as a reference

 general-concepts/autotools/text.xml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 6c6561a..02d8b30 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -675,6 +675,9 @@ For more details on autotools:
     <li>
       <uri link="https://www.gnu.org/software/m4/manual/m4.html">GNU m4 Manual</uri>
     </li>
+    <li>
+      <uri link="https://autotools.io">Autotools Mythbuster</uri>
+    </li>
   </ul>
   <li>
     There are some good overview lectures available online. <uri


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2014-01-21 17:09 Justin Lecher
  0 siblings, 0 replies; 7+ messages in thread
From: Justin Lecher @ 2014-01-21 17:09 UTC (permalink / raw
  To: gentoo-commits

commit:     de224473100c442774072427618a9718fa29df12
Author:     Justin Lecher <jlec <AT> gentoo <DOT> org>
AuthorDate: Tue Jan 21 17:07:00 2014 +0000
Commit:     Justin Lecher <jlec <AT> gentoo <DOT> org>
CommitDate: Tue Jan 21 17:07:00 2014 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=de224473

Use eauto* functions instead of plain tools in example

Bump to EAPI=5 and reference to autotools.eclass.

Signed-off-by: Justin Lecher <jlec <AT> gentoo.org>

---
 general-concepts/autotools/text.xml | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 6fb7bd8..7ae2024 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -97,6 +97,8 @@ The <c>autoreconf</c> tool supposedly runs <c>autoconf</c> (and <c>automake</c>,
 <c>autoheader</c>, <c>aclocal</c>, <c>autopoint</c> and <c>libtoolize</c>) as necessary.
 Sometimes it works. Some packages ship a shell script named <c>autogen.sh</c> which
 does the same thing (this is <e>not</e> related to <c>autogen</c>).
+The autotools.eclass contains helper functions for the stand-alone tools with their
+corresponding names e.g. <c>eautoconf</c> and <c>eautomake</c>.
 </p>
 
 <warning>
@@ -122,22 +124,23 @@ either <c>Makefile.am</c> or <c>configure.ac</c>:
 </p>
 
 <codesample lang="ebuild">
-src_unpack() {
-    unpack ${A}
-    cd "${S}"
+EAPI="5"
 
+inherit autotools
+
+src_prepare() {
     # Remove problematic LDFLAGS declaration
-    sed -i -e '/^LDFLAGS/d' src/Makefile.am
+    sed -i -e '/^LDFLAGS/d' src/Makefile.am || die
 
     # Rerun autotools
     einfo "Regenerating autotools files..."
-    WANT_AUTOCONF=2.5 autoconf || die "autoconf failed"
-    WANT_AUTOMAKE=1.9 automake || die "automake failed"
+    WANT_AUTOCONF=2.5 eautoconf
+    WANT_AUTOMAKE=1.9 eautomake
 }
 
 src_compile() {
     econf $(use_enable nls)
-    emake || die "emake failed"
+    emake
 }
 </codesample>
 


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2013-09-07 19:14 Markos Chandras
  0 siblings, 0 replies; 7+ messages in thread
From: Markos Chandras @ 2013-09-07 19:14 UTC (permalink / raw
  To: gentoo-commits

commit:     6caf536344d33440901d7238fb2ee14bc856d2b4
Author:     Michael Orlitzky <michael <AT> orlitzky <DOT> com>
AuthorDate: Sat Sep  7 18:44:49 2013 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Sep  7 19:12:08 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=6caf5363

Update an old suggestion in the Autotools Basics guide.

Fixes bug #484104.

---
 general-concepts/autotools/text.xml | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 181940c..6fb7bd8 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -76,10 +76,20 @@ and have the same format <d/> the only difference is the name.
 </note>
 
 <p>
-You will see autotools being used variously in both <c>src_unpack</c> and
-<c>src_compile</c>. The QA people prefer it in <c>src_unpack</c> <d/> the rationale is
-that <c>src_unpack</c> handles "getting the package ready to be compiled" <d/> but
-there is no official policy which mandates this.
+  You may see autotools being used in a variety of phase
+  functions. Prior to EAPI2, the QA team preferred that the source
+  code be manipulated in <c>src_unpack</c><d/>the rationale being that
+  <c>src_unpack</c> handles "getting the package ready to be
+  compiled."
+</p>
+
+<p>
+  EAPI2, however, introduced a new phase function: <uri
+  link="::ebuild-writing/functions/src_prepare" />. This is now the
+  appropriate place to manipulate the source code prior to
+  configuration and compilation. In particular, <c>src_prepare</c> is
+  called before <uri link="::ebuild-writing/functions/src_configure"
+  />, which usually expects the <c>configure</c> script to exist.
 </p>
 
 <p>


^ permalink raw reply related	[flat|nested] 7+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/
@ 2013-09-07 18:46 Markos Chandras
  0 siblings, 0 replies; 7+ messages in thread
From: Markos Chandras @ 2013-09-07 18:46 UTC (permalink / raw
  To: gentoo-commits

commit:     895593c4554a031780320990e5cb3b72cea5a346
Author:     Michael Orlitzky <michael <AT> orlitzky <DOT> com>
AuthorDate: Sat Sep  7 18:44:49 2013 +0000
Commit:     Markos Chandras <hwoarang <AT> gentoo <DOT> org>
CommitDate: Sat Sep  7 18:44:49 2013 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=895593c4

Update an old suggestion in the Autotools Basics guide.

Fixes bug #484104.

---
 general-concepts/autotools/text.xml | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/general-concepts/autotools/text.xml b/general-concepts/autotools/text.xml
index 181940c..6fb7bd8 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -76,10 +76,20 @@ and have the same format <d/> the only difference is the name.
 </note>
 
 <p>
-You will see autotools being used variously in both <c>src_unpack</c> and
-<c>src_compile</c>. The QA people prefer it in <c>src_unpack</c> <d/> the rationale is
-that <c>src_unpack</c> handles "getting the package ready to be compiled" <d/> but
-there is no official policy which mandates this.
+  You may see autotools being used in a variety of phase
+  functions. Prior to EAPI2, the QA team preferred that the source
+  code be manipulated in <c>src_unpack</c><d/>the rationale being that
+  <c>src_unpack</c> handles "getting the package ready to be
+  compiled."
+</p>
+
+<p>
+  EAPI2, however, introduced a new phase function: <uri
+  link="::ebuild-writing/functions/src_prepare" />. This is now the
+  appropriate place to manipulate the source code prior to
+  configuration and compilation. In particular, <c>src_prepare</c> is
+  called before <uri link="::ebuild-writing/functions/src_configure"
+  />, which usually expects the <c>configure</c> script to exist.
 </p>
 
 <p>


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

end of thread, other threads:[~2022-03-01  9:59 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-12-09  4:24 [gentoo-commits] proj/devmanual:master commit in: general-concepts/autotools/ Sam James
  -- strict thread matches above, loose matches on Subject: below --
2022-03-01  9:59 Sam James
2020-01-27 19:58 Ulrich Müller
2018-06-14 18:43 Göktürk Yüksek
2014-01-21 17:09 Justin Lecher
2013-09-07 19:14 Markos Chandras
2013-09-07 18:46 Markos Chandras

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