[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Lars Wendler (polynomial-c)]

polynomial-c    13/12/09 15:14:28

  Modified:             automagic.xml
  Log:
  Moved "Automagic dependencies" qa subpage to wiki.

Revision  Changes    Path
1.9                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.9&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.9&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.8&r2=1.9

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- automagic.xml	28 Oct 2012 15:21:11 -0000	1.8
+++ automagic.xml	9 Dec 2013 15:14:28 -0000	1.9
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.8 2012/10/28 15:21:11 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.9 2013/12/09 15:14:28 polynomial-c Exp $ -->
 
-<guide lang="en">
+<guide disclaimer="obsolete" redirect="https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Automagic_dependencies">
 <title>Automagic dependencies, what they are and how to fix them</title>
 
 <author title="Author">

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Diego Petteno (flameeyes)]

flameeyes    11/06/01 23:23:01

  Modified:             automagic.xml
  Log:
  Update guide improving the autotools code in it.
  
  Not only the code was using if/fi conditionals (which can conflict
  with pkg-config macros depending on the project), but it was using the
  == comparison bashism.
  
  Fix both so that the code is more compliant with proper autotools.
  
  Also rewrite the note about using cache values to work around the
  issues.

Revision  Changes    Path
1.7                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.7&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.7&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.6&r2=1.7

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- automagic.xml	8 Nov 2008 08:41:18 -0000	1.6
+++ automagic.xml	1 Jun 2011 23:23:01 -0000	1.7
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.6 2008/11/08 08:41:18 serkan Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.7 2011/06/01 23:23:01 flameeyes Exp $ -->
 
 <guide link="/proj/en/qa/automagic.xml" lang="en">
 <title>Automagic dependencies, what they are and how to fix them</title>
 
 <author title="Author">
-  <mail link="flameeyes@gentoo.org">Diego Pettenò</mail>
+  <mail link="flameeyes@gentoo.org">Diego Elio Pettenò</mail>
 </author>
 <author title="Author">
   <mail link="serkan@gentoo.org">Serkan Kaba</mail>
@@ -21,8 +21,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>0.2</version>
-<date>2008-11-07</date>
+<version>0.3</version>
+<date>2011-06-01</date>
 
 <chapter> <!-- Introduction -->
 <title>Introduction</title>
@@ -169,17 +169,17 @@
 <pre caption="Adding an enabled-by-default check for an optional dependency">
 <i>AC_ARG_WITH([foo], AS_HELP_STRING([--without-foo], [Build without foo library (default: test)]))</i>
 
-<i>if test "x$with_foo" != "xno"; then</i>
+<i>AS_IF([test "x$with_foo" != "xno"], [</i>
   PKG_CHECK_MODULES([FOO], [foo >= 0.1])
-<i>fi</i>
+<i>])</i>
 </pre>
 
 <pre caption="Adding a disabled-by-default check for an optional dependency">
 <i>AC_ARG_WITH([foo], AS_HELP_STRING([--with-foo], [Build with foo library (default: disabled)]))</i>
 
-<i>if test "x$with_foo" == "xyes"; then</i>
+<i>AS_IF([test "x$with_foo" = "xyes"], [</i>
   PKG_CHECK_MODULES([FOO], [foo >= 0.1])
-<i>fi</i>
+<i>])</i>
 </pre>
 
 <p>
@@ -199,13 +199,11 @@
 </warn>
 
 <p>
-There's actually another way to workaround, without fixing (and patching), the
-automagic dependencies generated by <b>AC_CHECK_LIB</b>, and it's by playing
-around with the cache values used by <c>autoconf</c>. This method is actually
-deprecated because it does not fix the issue to the roots and might create
-problems if upstream changes the tests a bit using a different cache variable
-name. Also, in this way fixes can't be sent upstream for integration in later
-versions.
+While it is possible to work around the issue of automagic dependencies without
+patching <c>configure.ac</c>, by messing with the autoconf cache values, this
+method is not recommended. This does not fix the original issue, and cannot be
+sent upstream for integration in new versions, and can actually conflict when
+tests are slightly different between environments.
 </p>
 
 </body>

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Serkan Kaba (serkan)]

serkan      08/11/08 08:41:18

  Modified:             automagic.xml
  Log:
  Make 'dependency' singular in code caption.

Revision  Changes    Path
1.6                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.6&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.6&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.5&r2=1.6

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- automagic.xml	8 Nov 2008 08:27:26 -0000	1.5
+++ automagic.xml	8 Nov 2008 08:41:18 -0000	1.6
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.5 2008/11/08 08:27:26 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.6 2008/11/08 08:41:18 serkan Exp $ -->
 
 <guide link="/proj/en/qa/automagic.xml" lang="en">
 <title>Automagic dependencies, what they are and how to fix them</title>
@@ -224,7 +224,7 @@
 value.
 </p>
 
-<pre caption="Adding ENABLE_FOO option to avoid automagic dependencies">
+<pre caption="Adding ENABLE_FOO option to avoid an automagic dependency">
 <i>OPTION(ENABLE_FOO "Enable foo library" ON)</i>
 ...
 <i>IF (ENABLE_FOO)</i>

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Joshua Saddler (nightmorph)]

nightmorph    08/11/08 08:27:26

  Modified:             automagic.xml
  Log:
  some minor guidexml edits per serkan's request via irc; no content change

Revision  Changes    Path
1.5                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.5&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.5&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.4&r2=1.5

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- automagic.xml	7 Nov 2008 21:58:25 -0000	1.4
+++ automagic.xml	8 Nov 2008 08:27:26 -0000	1.5
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.4 2008/11/07 21:58:25 serkan Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.5 2008/11/08 08:27:26 nightmorph Exp $ -->
 
 <guide link="/proj/en/qa/automagic.xml" lang="en">
 <title>Automagic dependencies, what they are and how to fix them</title>
@@ -217,12 +217,14 @@
 <body>
 
 <p>
-Automagic dependencies may occur in CMake based build systems where <b>PKG_CHECK_MODULES</b>
-is called without <b>REQUIRED</b> parameter unconditionally.
-Fixing this is quite easy as it only involves introducing an option to
-build system and executing <b>PKG_CHECK_MODULES</b> depending on its value.
+Automagic dependencies may occur in CMake-based build systems where
+<b>PKG_CHECK_MODULES</b> is called without the <b>REQUIRED</b> parameter
+unconditionally. Fixing this is quite easy, as it only involves introducing an
+option to build system and executing <b>PKG_CHECK_MODULES</b>, depending on its
+value.
 </p>
-<pre caption="Adding ENABLE_FOO option to avoid automagic dependency.">
+
+<pre caption="Adding ENABLE_FOO option to avoid automagic dependencies">
 <i>OPTION(ENABLE_FOO "Enable foo library" ON)</i>
 ...
 <i>IF (ENABLE_FOO)</i>
@@ -237,11 +239,13 @@
   ENDIF (FOO_FOUND)
 <i>ENDIF (ENABLE_FOO)</i>
 </pre>
-<note>Set the default in OPTION according to original behavior.</note>
-</body>
 
-</section>
+<note>
+Set the default in OPTION according to the original behavior.
+</note>
 
+</body>
+</section>
 <section> <!-- Other build systems -->
 <title>Other build systems</title>
 

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Serkan Kaba (serkan)]

serkan      08/11/07 21:58:25

  Modified:             automagic.xml
  Log:
   * Add CMake section.
   * Fix for US English.

Revision  Changes    Path
1.4                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.4&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.4&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.3&r2=1.4

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- automagic.xml	25 Jan 2008 18:12:26 -0000	1.3
+++ automagic.xml	7 Nov 2008 21:58:25 -0000	1.4
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.3 2008/01/25 18:12:26 flameeyes Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.4 2008/11/07 21:58:25 serkan Exp $ -->
 
 <guide link="/proj/en/qa/automagic.xml" lang="en">
 <title>Automagic dependencies, what they are and how to fix them</title>
@@ -8,6 +8,9 @@
 <author title="Author">
   <mail link="flameeyes@gentoo.org">Diego Pettenò</mail>
 </author>
+<author title="Author">
+  <mail link="serkan@gentoo.org">Serkan Kaba</mail>
+</author>
 
 <abstract>
 This guide aim to describe the problem of "automagic dependencies", describing
@@ -18,8 +21,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>0.1</version>
-<date>2006-01-30</date>
+<version>0.2</version>
+<date>2008-11-07</date>
 
 <chapter> <!-- Introduction -->
 <title>Introduction</title>
@@ -58,7 +61,7 @@
 they are building it, sometimes dependencies get <e>automagic</e>. This means
 that the build system doesn't give the builder a way to decide if he wants
 something enabled, so the dependency added, but they just enable it when they
-find it. This is the wrong behaviour.
+find it. This is the wrong behavior.
 </p>
 
 </body>
@@ -157,7 +160,7 @@
 
 <note>
 For the patches to be accepted by upstream, it's usually suggested not to change
-the default behaviour, when <c>./configure</c> is called without parameters; for
+the default behavior, when <c>./configure</c> is called without parameters; for
 this reason, here will be listed two methods to make non-automagic the
 dependencies, one for enabled-by-default deps and one for disabled-by-default
 deps.
@@ -180,7 +183,7 @@
 </pre>
 
 <p>
-When the parameter is present but it's not honoured, it might be simple as well
+When the parameter is present but it's not honored, it might be simple as well
 as complex to fix the dependency. It might just be a test that's not properly
 written, so it has to be changed in something alike to the tests above, or it
 might be a complete screw-up in calls of <b>AC_ARG_WITH</b> macros. In those
@@ -208,6 +211,37 @@
 </body>
 </section>
 
+<section><!-- CMake -->
+<title>CMake</title>
+
+<body>
+
+<p>
+Automagic dependencies may occur in CMake based build systems where <b>PKG_CHECK_MODULES</b>
+is called without <b>REQUIRED</b> parameter unconditionally.
+Fixing this is quite easy as it only involves introducing an option to
+build system and executing <b>PKG_CHECK_MODULES</b> depending on its value.
+</p>
+<pre caption="Adding ENABLE_FOO option to avoid automagic dependency.">
+<i>OPTION(ENABLE_FOO "Enable foo library" ON)</i>
+...
+<i>IF (ENABLE_FOO)</i>
+  PKG_CHECK_MODULES (FOO foo>=0.1)
+<i>ENDIF (ENABLE_FOO)</i>
+...
+<i>IF (ENABLE_FOO)</i>
+  IF (FOO_FOUND)
+  ...
+  ELSE (FOO_FOUND)
+  ...
+  ENDIF (FOO_FOUND)
+<i>ENDIF (ENABLE_FOO)</i>
+</pre>
+<note>Set the default in OPTION according to original behavior.</note>
+</body>
+
+</section>
+
 <section> <!-- Other build systems -->
 <title>Other build systems</title>
 

[gentoo-commits] gentoo commit in xml/htdocs/proj/en/qa: automagic.xml

[Diego Petteno (flameeyes)]

flameeyes    08/01/25 18:12:27

  Modified:             automagic.xml
  Log:
  Fix a few grammar mistakes.

Revision  Changes    Path
1.3                  xml/htdocs/proj/en/qa/automagic.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.3&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?rev=1.3&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/qa/automagic.xml?r1=1.2&r2=1.3

Index: automagic.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- automagic.xml	30 Jan 2006 05:52:05 -0000	1.2
+++ automagic.xml	25 Jan 2008 18:12:26 -0000	1.3
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.2 2006/01/30 05:52:05 flameeyes Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/qa/automagic.xml,v 1.3 2008/01/25 18:12:26 flameeyes Exp $ -->
 
 <guide link="/proj/en/qa/automagic.xml" lang="en">
 <title>Automagic dependencies, what they are and how to fix them</title>
@@ -29,7 +29,7 @@
 <body>
 
 <p>
-The so-called <e>automagic dependecies</e> are shallow dependencies of a
+The so-called <e>automagic dependencies</e> are shallow dependencies of a
 software recognized at build or runtime and changes the way the software works.
 The name <e>automagic</e> is a pun referred to the use of GNU autotools, that
 produces most of the cases of <e>automagic dependencies</e>.
@@ -101,7 +101,7 @@
 When a package has automagic dependencies there are only two things that can
 be done: the first is to state the dependency as mandatory, no matter what the
 users put in their USE variable, but that might mean that some support that
-people don't want is always enable and its dependencies pulle din; the other
+people don't want is always enable and its dependencies pulled in; the other
 is to fix the build system to be able to disable at build time the dependency
 also if it's present on the system.
 </p>
@@ -150,7 +150,7 @@
 corresponding variable before doing the test. It's useful to know that the first
 parameter passed to the above macro actually names a variable that gets loaded
 by <c>autoconf</c> without having to add the extra parameters for action to
-execute when the parameter is present and when it's not, the variale is named
+execute when the parameter is present and when it's not, the variable is named
 <path>$enable_foo</path> or <path>$with_bar</path>, depending on which of the
 two macros are called.
 </p>
@@ -183,7 +183,7 @@
 When the parameter is present but it's not honoured, it might be simple as well
 as complex to fix the dependency. It might just be a test that's not properly
 written, so it has to be changed in something alike to the tests above, or it
-might be a complete screwup in calls of <b>AC_ARG_WITH</b> macros. In those
+might be a complete screw-up in calls of <b>AC_ARG_WITH</b> macros. In those
 cases, it's better to check the code carefully and contact upstream if a screw
 up seems likely.
 </p>



-- 
gentoo-commits@lists.gentoo.org mailing list