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
147The rules in `gint.mk` make certain assumptions about some `Makefile` 147The rules in `gint.mk` make certain assumptions about some `Makefile`
148variables. Namely, the following variables must be defined before 148variables. Namely, the following variables must be defined before
149including the file: +INCLUDES+, +EXTRA_DIST+, +CLEANFILES+, 149including the file: +INCLUDES+, +EXTRA_DIST+, +CLEANFILES+,
150+DISTCLEANFILES+, +SUFFIXES+, +BUILT_SOURCES+. See the 150+DISTCLEANFILES+ (or +MAINTAINERCLEANFILES+, if +doc-distrib+
151option is used), +SUFFIXES+, +BUILT_SOURCES+. See the
151http://sources.redhat.com/automake/automake.html[`Automake` documentation], 152http://sources.redhat.com/automake/automake.html[`Automake` documentation],
152for more info on these. If no special value is needed, define each 153for more info on these. If no special value is needed, define each
153of them to an empty string (see example below). 154of them to an empty string (see example below).
@@ -248,6 +249,19 @@ The following is a list of valid options:
248nodoc:: 249nodoc::
249Disable generation of +.doc+ files (see <<doc-snarfing, Doc snarfing>>). 250Disable generation of +.doc+ files (see <<doc-snarfing, Doc snarfing>>).
250 251
252doc-distrib::
253Add generated docfiles to distribution tarball. The following files are
254added: +\*.doc+, +\*.x+, +guile-procedures.texi+ and +guile-procedures.txt+.
255Normally they are not distributed and are recreated on each built. A minor
256drawback of this approach is that it requires installers to have *makeinfo*
257installed. If this option is given, the files will be included in the
258tarball and no rebuild will be necessary.
259+
260If this option is used, +MAINTAINERCLEANFILES+ must be defined before
261including +gint.mk+.
262+
263See also <<doc-snarfing, Doc snarfing>>.
264
251inc:: 265inc::
252Enable generation of `.inc` files. Each such file contains a set of 266Enable generation of `.inc` files. Each such file contains a set of
253`export` statements, one for each `SCM_DEFINE` in the corresponding 267`export` statements, one for each `SCM_DEFINE` in the corresponding
@@ -489,7 +503,16 @@ GINT_LDADD::
489Notice also that if your code does not require doc snarfing, you 503Notice also that if your code does not require doc snarfing, you
490may disable it by supplying the +nodoc+ option to the invocation 504may disable it by supplying the +nodoc+ option to the invocation
491of +GINT_INIT+. 505of +GINT_INIT+.
492 506
507By default, doc files are not included in the distribution tarball, which
508means that they will be recreated at build time. Creation of
509+guile-procedures.txt+ requires *makeinfo*, which may not always be present.
510To simplify built requirements, you can instruct +GINT+ to include the generated
511files to the distribution. To do so, add the +doc-distrib+ option to the
512invocation of +GINT_INIT+. The following files will be included in the
513distribution: +\*.doc+, +\*.x+, +guile-procedures.texi+ and
514+guile-procedures.txt+.
515
493[[guile-site-dir]] 516[[guile-site-dir]]
494THE `SITE DIRECTORY' PROBLEM 517THE `SITE DIRECTORY' PROBLEM
495---------------------------- 518----------------------------

Return to:

Send suggestions and report system problems to the System administrator.