doc: Mention effect of 'autoreconf -fi' on INSTALL
commit968215e7b4ea65e32ca7eda8fc5b211b4cec61d0
authorEric Blake <eblake@redhat.com>
Thu, 22 Dec 2016 23:16:08 +0000 (22 17:16 -0600)
committerEric Blake <eblake@redhat.com>
Fri, 23 Dec 2016 16:00:56 +0000 (23 10:00 -0600)
tree13c1e0e1d183be2cb1dff0e95dfbb3b39d374f4a
parenta6b2acf29d66a1824572c27c2104d24a2b034790
doc: Mention effect of 'autoreconf -fi' on INSTALL

Several projects have a bootstrap script that invokes
'autoreconf -fi' as part of a fresh version control checkout,
in order to avoid storing common files in version control,
while also allowing contributors to rerun bootstrap to pick
up the benefits of any upgrade of one of the autotools.

However, the documentation did not make it obvious that such
a setup will overwrite any customizations to files like
INSTALL, if those files are stored in version control, when
automake still considers that file to be standard based on
AM_INIT_AUTOMAKE settings.  In such a case, a mere
'autoreconf -i' is good for the bootstrap script, while a
separate 'autoreconf -f' is good for picking up on an upgrade
of any autotools.

* bin/autoreconf.in (help): Mention standard files.
* doc/autoconf.texi (autoreconf Invocation): Add more text, including
warning that mixing --force and --install may undo customizations,
and that the set of files impacted is controlled by automake.
Reported by Emil Laine <laine.emil@gmail.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
bin/autoreconf.in
doc/autoconf.texi