summaryrefslogtreecommitdiff
path: root/doc/gnulib-tool.texi
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2018-01-23 09:13:13 +0100
committerBruno Haible <bruno@clisp.org>2018-01-23 09:13:13 +0100
commitc989777f821e39a4b7916c9212fe00289be1bff6 (patch)
treed0469371a49201697428e77dea36b6e5f47c293c /doc/gnulib-tool.texi
parent7eba4a9ac9cb65ae501365d5d7cad83430c37d92 (diff)
downloadgnulib-c989777f821e39a4b7916c9212fe00289be1bff6.tar.gz
doc: Mention another prerequisite for using Gnulib.
Reported at <https://stackoverflow.com/questions/48378214/>. * doc/gnulib-tool.texi (Initial import): Mention requirement to use AC_CONFIG_HEADERS.
Diffstat (limited to 'doc/gnulib-tool.texi')
-rw-r--r--doc/gnulib-tool.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/gnulib-tool.texi b/doc/gnulib-tool.texi
index 1a75f073bd..302fe880b9 100644
--- a/doc/gnulib-tool.texi
+++ b/doc/gnulib-tool.texi
@@ -87,6 +87,14 @@ module that contains this source file, you can use the command
Gnulib assumes that your project uses Autoconf. When using Gnulib, you
will need to have Autoconf among your build tools.
+Gnulib also assumes that your project's @file{configure.ac} contains the
+line
+@smallexample
+AC_CONFIG_HEADERS([config.h])
+@end smallexample
+The @file{config.h} file gets generated with platform dependent C macro
+definitions, and the source files include it (see @ref{Source changes}).
+
Unless you use @command{gnulib-tool}'s @option{--gnu-make} option,
Gnulib also assumes that your project uses Automake at least in a
subdirectory of your project. While the use of Automake in your