regenerate manual
diff --git a/doc/pyconfigure.info b/doc/pyconfigure.info --- a/doc/pyconfigure.info +++ b/doc/pyconfigure.info @@ -1,7 +1,7 @@ -This is pyconfigure.info, produced by makeinfo version 4.13 from -/home/brandon/Projects/python-autoconfigure/doc/pyconfigure.texi. +This is doc/pyconfigure.info, produced by makeinfo version 4.13 from +./doc/pyconfigure.texi. -This manual is for pyconfigure (version 0.1, updated 3 November 2012). +This manual is for pyconfigure (version 0.1, updated 25 November 2012). Copyright (C) 2012 Brandon Invergo @@ -24,7 +24,7 @@ File: pyconfigure.info, Node: Top, Nex GNU Source Release Collection ***************************** -This manual is for pyconfigure (version 0.1, 3 November 2012). +This manual is for pyconfigure (version 0.1, 25 November 2012). * Menu: @@ -132,18 +132,47 @@ script. This script either guesses impor provided them by the user. When the user invokes `configure', it uses `Makefile.in' as a template to create the Make recipe `Makefile'. - Several Autoconf macros are provided in the pyconfigure file -`src/m4/python.m4' to allow the developer to write robust tests *Note -Autoconf macros::. Note that when you distribute your software, you -must include this directory and file with your distribution. + There are some minimum modifications that should be made. In +`configure.ac' you will see a macro called `AC_INIT'. You should enter +your project's name as the first argument to this macro, its current +version as the second argument and, optionally, an email address in the +third argument. These three values are used extensively in the files +modified by the configure script, so it is important that you modify +them. + + You will probably also want to provide package metadata, which will +be used by Python packaging-related tools. You can do that in two files: +`PKG-INFO.in' and `setup.py.in'. `setup.py.in' provides a skeleton +`setup.py' which should be sufficient for most packages. `PKG-INFO' is +a file used in Python packaging to express package metadata and must be +included in any source distribution of a package. You may also use it +to register a project on PyPI (the Python Package Index; +http://pypi.python.org). In both `PKG-INFO.in' and `setup.py.in', you +can see that some values will be automatically filled in by +`configure'. You should fill in the rest yourself. See the Python +distutils documentation for more information. + + If you intend to produce source distributions via the `Makefile', +which is more flexible than doing so via `setup.py', it is important to +modify the `DIST_FILES' variable in `Makefile.in'. Any file or +directory you list there will be included in your source distribution. + + While the default `configure' script will likely be sufficient for a +basic Python-based project, it may be made much more powerful for +packages with more complex needs. To that end, several Autoconf macros +are provided in the pyconfigure file `src/m4/python.m4' to allow the +developer to write robust tests *Note Autoconf macros::. Note that when +you distribute your software, you must include this directory and file +with your distribution if you also distribute your `configure.ac' file. Once you modify your `configure.ac' to your liking, you must regenerate your `configure' script with autoreconf: $ autoreconf -fvi - A full explanation of the use of Autoconf macros is beyond the scope -of this document, however it is worth presenting some examples. + A full explanation of the general use of Autoconf macros is beyond +the scope of this document, however it is worth presenting some +examples. * Menu: @@ -221,21 +250,14 @@ 3.x installed, `configure' must be able 2.x version installed. This is slightly less straight-forward, but one possible implementation is as follows: - PC_PYTHON_VERIFY_VERSION([$PYTHON], 3.0, - py3k=true, - py3k=false) - # If a Python 3 interpreter was found, look specifically for a Python 2 one - if test "$py3k" = "true" ; then - m4_define_default([_PYTHON2_BINS], [python2 python2.7 python2.6]) - AC_PATH_PROGS(PYTHON, [_PYTHON2_BINS]) - else - # otherwise check that the Python 2 version is sufficient - PC_PYTHON_VERIFY_VERSION([$PYTHON], python_min_ver, , - [AC_MSG_ERROR(Python interpreter too old)]) + AC_PROG_PYTHON([python2]) + if [[ "x$PYTHON" == "x" ]]; then + AC_PROG_PYTHON + PC_PYTHON_VERIFY_VERSION(3.0, , + AC_MSG_ERROR(Python 2 (python_min_ver+) is required)) fi - if test -z "$PYTHON"; then - AC_MSG_ERROR(No Python 2 interpreter found) - fi + PC_PYTHON_VERIFY_VERSION(python_min_ver, , + AC_MSG_ERROR(Python 2 (python_min_ver+) is required)) We first check to see if Python is version 3.0 or greater. If it is, we create a list of compatible Python interpreters and manually check @@ -898,17 +920,17 @@ permit their use in free software. Tag Table: -Node: Top806 -Node: Introduction1407 -Node: Configuring Python packages2838 -Node: Using pyconfigure4062 -Node: Required macros5530 -Node: Verifying the Python version6710 -Node: Checking for a module or function9227 -Node: Writing test programs10447 -Node: Using Sphinxbuild to build documentation11541 -Node: Appendix12551 -Node: Autoconf macros12722 -Node: GNU Free Documentation License16420 +Node: Top769 +Node: Introduction1371 +Node: Configuring Python packages2802 +Node: Using pyconfigure4026 +Node: Required macros7153 +Node: Verifying the Python version8333 +Node: Checking for a module or function10476 +Node: Writing test programs11696 +Node: Using Sphinxbuild to build documentation12790 +Node: Appendix13800 +Node: Autoconf macros13971 +Node: GNU Free Documentation License17669 End Tag Table diff --git a/doc/stamp-vti b/doc/stamp-vti --- a/doc/stamp-vti +++ b/doc/stamp-vti @@ -1,4 +1,4 @@ -@set UPDATED 3 November 2012 +@set UPDATED 25 November 2012 @set UPDATED-MONTH November 2012 @set EDITION 0.1 @set VERSION 0.1 diff --git a/doc/version.texi b/doc/version.texi --- a/doc/version.texi +++ b/doc/version.texi @@ -1,4 +1,4 @@ -@set UPDATED 3 November 2012 +@set UPDATED 25 November 2012 @set UPDATED-MONTH November 2012 @set EDITION 0.1 @set VERSION 0.1