aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README27
1 files changed, 25 insertions, 2 deletions
diff --git a/README b/README
index 58f9b9f..5975884 100644
--- a/README
+++ b/README
@@ -147,7 +147,8 @@ include ../gint/gint.mk
The rules in `gint.mk` make certain assumptions about some `Makefile`
variables. Namely, the following variables must be defined before
including the file: +INCLUDES+, +EXTRA_DIST+, +CLEANFILES+,
-+DISTCLEANFILES+, +SUFFIXES+, +BUILT_SOURCES+. See the
++DISTCLEANFILES+ (or +MAINTAINERCLEANFILES+, if +doc-distrib+
+option is used), +SUFFIXES+, +BUILT_SOURCES+. See the
http://sources.redhat.com/automake/automake.html[`Automake` documentation],
for more info on these. If no special value is needed, define each
of them to an empty string (see example below).
@@ -248,6 +249,19 @@ The following is a list of valid options:
nodoc::
Disable generation of +.doc+ files (see <<doc-snarfing, Doc snarfing>>).
+doc-distrib::
+Add generated docfiles to distribution tarball. The following files are
+added: +\*.doc+, +\*.x+, +guile-procedures.texi+ and +guile-procedures.txt+.
+Normally they are not distributed and are recreated on each built. A minor
+drawback of this approach is that it requires installers to have *makeinfo*
+installed. If this option is given, the files will be included in the
+tarball and no rebuild will be necessary.
++
+If this option is used, +MAINTAINERCLEANFILES+ must be defined before
+including +gint.mk+.
++
+See also <<doc-snarfing, Doc snarfing>>.
+
inc::
Enable generation of `.inc` files. Each such file contains a set of
`export` statements, one for each `SCM_DEFINE` in the corresponding
@@ -489,7 +503,16 @@ GINT_LDADD::
Notice also that if your code does not require doc snarfing, you
may disable it by supplying the +nodoc+ option to the invocation
of +GINT_INIT+.
-
+
+By default, doc files are not included in the distribution tarball, which
+means that they will be recreated at build time. Creation of
++guile-procedures.txt+ requires *makeinfo*, which may not always be present.
+To simplify built requirements, you can instruct +GINT+ to include the generated
+files to the distribution. To do so, add the +doc-distrib+ option to the
+invocation of +GINT_INIT+. The following files will be included in the
+distribution: +\*.doc+, +\*.x+, +guile-procedures.texi+ and
++guile-procedures.txt+.
+
[[guile-site-dir]]
THE `SITE DIRECTORY' PROBLEM
----------------------------

Return to:

Send suggestions and report system problems to the System administrator.