changeset 7460:b82874ef9c54

Emphasize the drawbacks of the --symlink option.
author Bruno Haible <bruno@clisp.org>
date Mon, 09 Oct 2006 12:26:13 +0000
parents ed1c08123d81
children 3fde075b3d7f
files doc/ChangeLog doc/gnulib-tool.texi
diffstat 2 files changed, 12 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2006-10-08  Bruno Haible  <bruno@clisp.org>
+
+	* gnulib-tool.texi: Emphasize the drawbacks of the --symlink option.
+
 2006-09-19  Karl Berry  <karl@gnu.org>
 
 	* gnulib.texi: note about the license texinfo files.
--- a/doc/gnulib-tool.texi
+++ b/doc/gnulib-tool.texi
@@ -90,8 +90,14 @@
 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