From: Bruno Haible Date: Mon, 9 Oct 2006 12:26:13 +0000 (+0000) Subject: Emphasize the drawbacks of the --symlink option. X-Git-Tag: cvs-readonly~1758 X-Git-Url: http://erislabs.net/gitweb/?a=commitdiff_plain;h=3fc0d6e82c20fcee926ba604d338afe433eaa24e;p=gnulib.git Emphasize the drawbacks of the --symlink option. --- diff --git a/doc/ChangeLog b/doc/ChangeLog index 0e2963187..3bee978f4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2006-10-08 Bruno Haible + + * gnulib-tool.texi: Emphasize the drawbacks of the --symlink option. + 2006-09-19 Karl Berry * gnulib.texi: note about the license texinfo files. diff --git a/doc/gnulib-tool.texi b/doc/gnulib-tool.texi index f8e3f83d5..01ea29d12 100644 --- a/doc/gnulib-tool.texi +++ b/doc/gnulib-tool.texi @@ -90,8 +90,14 @@ are copied into the directory specified by @samp{AC_CONFIG_AUX_DIR} in neither is specified, the current directory is assumed. @code{gnulib-tool} can make symbolic links instead of copying the -source files. Use the @samp{--symbolic} (or @samp{-s} for short) option -to do this. +source files. The option to specify for this is @samp{--symlink}, or +@samp{-s} for short. This can be useful to save a few kilobytes of disk +space. But it is likely to introduce bugs when @code{gnulib} is updated; +it is more reliable to use @samp{gnulib-tool --update} (see below) +to update to newer versions of @code{gnulib}. Furthermore it requires +extra effort to create self-contained tarballs, and it may disturb some +mechanism the maintainer applies to the sources. For these reasons, +this option is generally discouraged. @code{gnulib-tool} will overwrite any pre-existing files, in particular @file{Makefile.am}. Unfortunately, separating the