[Gsrc-commit] /srv/bzr/gsrc/trunk r914: update documentation and version number

[Brandon Invergo]

------------------------------------------------------------
revno: 914
committer: Brandon Invergo <address@hidden>
branch nick: trunk
timestamp: Sat 2012-09-01 16:34:09 +0200
message:
  update documentation and version number
modified:
  configure.ac
  doc/gsrc.texi
  doc/version.texi

=== modified file 'configure.ac'
--- a/configure.ac      2011-08-24 16:32:16 +0000
+++ b/configure.ac      2012-09-01 14:34:09 +0000
@@ -1,4 +1,4 @@
-AC_INIT(gsrc, 1.0.1, address@hidden)
+AC_INIT(gsrc, 2012.09.01, address@hidden)
 AC_CONFIG_SRCDIR([gar.mk])
 
 AM_INIT_AUTOMAKE([foreign])

=== modified file 'doc/gsrc.texi'
--- a/doc/gsrc.texi     2011-09-02 14:13:17 +0000
+++ b/doc/gsrc.texi     2012-09-01 14:34:09 +0000
@@ -7,9 +7,10 @@
 @syncodeindex pg cp
 @comment %**end of header
 @copying
-This manual is for the GNU Source Release Collection (version @value{VERSION}, 
@value{UPDATED}).
+This manual is for the GNU Source Release Collection (version
address@hidden, updated @value{UPDATED}).
 
-Copyright @copyright{} 2011 Free Software Foundation, Inc.
+Copyright @copyright{} 2011, 2012 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -65,6 +66,11 @@
 * Cleaning up and other useful targets::  
 * Building a more complex package::  
 
+Advanced configuration
+
+* Global configuration::
+* Package configuration::
+
 @end detailmenu
 @end menu
 
@@ -379,6 +385,19 @@
 @node Advanced configuration, GNU Free Documentation License, Getting started, 
Top
 @chapter Advanced configuration
 
+The default behavior of GSRC may be configured, both globally and for
+individual packages. All configuration is done in simple Makefiles, so
+some familiarity with GNU Make, while not required, is recommended for
+more advanced changes.
+
address@hidden
+* Global configuration::
+* Package configuration::
address@hidden menu
+
address@hidden Global configuration, Package configuration, , Advanced 
configuration
address@hidden Global configuration
+
 The build loads the following configuration files:
 
 @table @file
@@ -390,13 +409,14 @@
 @item gar.env.mk
 Defines the environment variables that are set during each build step.
 @item gar.master.mk
-Defines the list of mirror sites used to download the source tarballs.
+Defines the list of mirror sites used to download the source
+tarballs. It is recommended to modify this to use local mirrors.
 @end table
 
 The local file @file{gar.site.mk} is loaded last and can be used to
 override any configuration variables.
 
-Some of the more important configuration variables are,
+Some of the more important configuration variables are:
 
 @table @code
 @item BOOTSTRAP
@@ -432,7 +452,53 @@
 
 @end table
 
-
address@hidden Package configuration, ,Global configuration, Advanced 
configuration
address@hidden Pacage configuration
+
+The build process for each package can be highly customized within its
+own Makefile. Because GNU packages follow a standardized build
+process, customizing the GSRC Makefile for one is
+straightforward. 
+
+GNU packages take most of their configuration in the form of options
+passed to the @file{configure} script. One may easily customize these
+options in a GSRC Makefile by setting the CONFIGURE_OPTS variable. Any
+options added to this variable will be appended to the options set by
+default by GSRC. Thus, since GSRC already sets the @code{--prefix}
+option, you need not specify it here.
+
address@hidden
+CONFIGURE_OPTS = --disable-gtk --without-png
address@hidden example
+
+If you have a patch which you would like to apply to the package, the
+process may be automated by GSRC. First, in the package's directory,
+make a subdirectory called @file{files/} and move the patch file(s)
+there. Next, create two variables in the package's Makefile:
+
address@hidden
+PATCHFILES = my-patch.diff my-patch2.diff
+PATCHOPTS = -p0
address@hidden example
+
address@hidden holds a list of all the patch files in the
address@hidden/} subdirectory. @code{PATCHOPTS} contains the option switches
+to pass to the @code{patch} program. Next, the patch file's checksum
+is added to the checksums file for the package. Finally, you may build
+the package as normal, with the patch being applied automatically in
+the process.
+
address@hidden
+$ make makesums install
address@hidden example
+
+Note that if the @code{make makesums} command fails due to GPG
+verification and you trust the source from which the package was
+downloaded, you may instead use @code{make makesums GPGV=true} to skip
+this key verification step.
+
+If the package requires a patch to even build properly, then this is a
+bug in GSRC. Please report such build problems to @email{bug-gsrc@@gnu.org}.
 
 @node GNU Free Documentation License,  , Advanced configuration, Top
 @appendix GNU Free Documentation License

=== modified file 'doc/version.texi'
--- a/doc/version.texi  2011-08-24 16:32:16 +0000
+++ b/doc/version.texi  2012-09-01 14:34:09 +0000
@@ -1,4 +1,4 @@
address@hidden UPDATED 9 August 2011
address@hidden UPDATED-MONTH August 2011
address@hidden EDITION 1.0.1
address@hidden VERSION 1.0.1
address@hidden UPDATED 1 September 2012
address@hidden UPDATED-MONTH September 2012
address@hidden EDITION 2012.09.01
address@hidden VERSION 2012.09.01