Mercurial > hg > octave-nkf > gnulib-hg
changeset 13639:b68fa3d66e47
Update doc about gnulib-tool.
* doc/gnulib-tool.texi (VCS Issues): Explain 'gnulib-tool --import' vs.
'gnulib-tool --update' in more detail.
Reported by Eric Blake.
author | Bruno Haible <bruno@clisp.org> |
---|---|
date | Sat, 04 Sep 2010 19:28:12 +0200 |
parents | 8ae47cf4002f |
children | 66184fbdcf03 |
files | ChangeLog doc/gnulib-tool.texi |
diffstat | 2 files changed, 30 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2010-09-04 Bruno Haible <bruno@clisp.org> + + Update doc about gnulib-tool. + * doc/gnulib-tool.texi (VCS Issues): Explain 'gnulib-tool --import' vs. + 'gnulib-tool --update' in more detail. + Reported by Eric Blake. + 2010-09-04 Bruno Haible <bruno@clisp.org> gnulib-tool: Change --import. New options --add/remove-import.
--- a/doc/gnulib-tool.texi +++ b/doc/gnulib-tool.texi @@ -594,20 +594,34 @@ @item In projects which customarily omit from their VCS all files that are generated from other source files, none of these files and directories -are added into the VCS. The only file that must be added to the VCS -is @file{gnulib-cache.m4} in the M4 macros directory. Also, the -script for restoring files not in the VCS, customarily called -@file{autogen.sh} or @file{bootstrap}, will typically contain the -statement for restoring the omitted files: +are added into the VCS. As described in @ref{Modified imports}, there +are two ways to keep track of options and module names that are passed +to @code{gnulib-tool}. The command for restoring the omitted files +depends on it: + +@itemize @bullet +@item +If they are stored in a file other than @code{gnulib-cache.m4}, such as +@file{autogen.sh}, @file{bootstrap}, @file{bootstrap.conf}, or similar, +the restoration command is the entire @code{gnulib-tool ... --import ...} +invocation with all options and module names. + +@item +If the project relies on @code{gnulib-tool}'s memory of the last used +options and module names, then the file @file{gnulib-cache.m4} in the M4 +macros directory must be added to the VCS, and the restoration command +is: @smallexample $ gnulib-tool --update @end smallexample -The @samp{--update} option operates much like the @samp{--import} option, -but it does not offer the possibility to change the way Gnulib is used. -Also it does not report in the ChangeLogs the files that it had to add -because they were missing. +The @samp{--update} option operates much like the @samp{--add-import} +option, but it does not offer the possibility to change the way Gnulib is +used. Also it does not report in the ChangeLogs the files that it had to +add because they were missing. + +@end itemize Gnulib includes the file @file{build-aux/bootstrap} to aid a developer in using this setup. Furthermore, in projects that use git for