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