Mercurial > hg > octave-lojdl > gnulib-hg
changeset 6951:9934ce51cefd
Mention where to put documentation.
| author | Bruno Haible <bruno@clisp.org> |
|---|---|
| date | Tue, 11 Jul 2006 11:59:13 +0000 |
| parents | 9c46029b6970 |
| children | b1f02ed7eeab |
| files | ChangeLog README |
| diffstat | 2 files changed, 10 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2006-07-11 Bruno Haible <bruno@clisp.org> + + * README: Mention where to put documentation. + 2006-07-09 Paul Eggert <eggert@cs.ucla.edu> * build-aux/depcomp, build-aux/install-sh: Sync from Automake.
--- a/README +++ b/README @@ -59,6 +59,12 @@ * If the module needs configure-time checks, write an autoconf macro for it in m4/<module>.m4. See m4/README for details. * Write a module description modules/<module>, based on modules/TEMPLATE. +* If the module contributes a section to the end-user documentation, + put this documentation in doc/<module>.texi and add it to the "Files" + section of modules/<module>. Most modules don't do this; they have only + documentation for the programmer (= gnulib user). Such documentation + usually goes into the lib/ source files. It may also go into doc/; + but don't add it to the module description in this case. * Add the module to the list in MODULES.html.sh. You can test that a module builds correctly with: