From ad0e2df84106cc668a36689d7a714ac966d5d544 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Mon, 22 Jan 1996 08:07:44 +0000 Subject: [PATCH] Doc fixes --- TODO | 11 ++++++----- automake.texi | 39 ++++++++++++++++++++++++++++++--------- version.texi | 2 +- 3 files changed, 37 insertions(+), 15 deletions(-) diff --git a/TODO b/TODO index c01ce58..f127065 100644 --- a/TODO +++ b/TODO @@ -6,8 +6,9 @@ Top priorities: Handle MAINT_CHARSET. Use recode in dist target. Handle dist-zoo and dist-zip. -Add support for html via an option. Use texi2html. Use "html_HTMLS", -and htmldir = .../html. Include html files in distribution. +Add support for html via an option. Use texi2html. Use +"html_TEXINFOS", and htmldir = .../html. Include html files in +distribution. Also allow "html_DATA", for raw .html files. if configure.in not found, move up a directory and try again? This could eliminate a common source of problems. @@ -41,6 +42,8 @@ Consider automatic support for ".y" files. [ not right now; it is nice to be able to print the number of expected conflicts, and we can't handle that ] What about ".l" files? +Consider supporting syntax from autoconf "derived:source", eg: + y.tab.c:perly.y Write autoconf macro to do all work necessary for automake. Eg define PACKAGE, VERSION, etc. @@ -195,17 +198,15 @@ putting .h files into blah_SOURCES is ok now Libraries: -X Need a way to specify library should be installed * Should support standalone library along with subdir library in same Makefile.am. Maybe: turn off "standalone" mode if library's Makefile.am is not only one specd? [ add an option for this ] -X Need a way to install library header files. * Need a way to handle shared libraries. It would be really interesting to be able to easily (as the end-user) make many different versions of the library: shared, static, profiling, debug, optimized... How does Perl handle this? -X Must ranlib libraries after installing + This needs autoconf support Some examples to keep in mind while doing this: * readline diff --git a/automake.texi b/automake.texi index db7144e..3492e90 100644 --- a/automake.texi +++ b/automake.texi @@ -242,7 +242,7 @@ The @samp{SUBDIRS} macro holds a list of subdirectories in which building of various sorts can occur. Many targets (eg @samp{all}) in the generated @file{Makefile} will run both locally and in all specified subdirectories. Note that the directories listed in @samp{SUBDIRS} are -not expected to contain @file{Makefile.am}s; only @file{Makefile}s +not required to contain @file{Makefile.am}s; only @file{Makefile}s (after configuration). This allows inclusion of libraries from packages which do not use @code{automake} (such as @code{gettext}). @@ -294,10 +294,8 @@ The special prefix @code{noinst} indicates that the objects in question should not be installed at all. Possible primary names are @samp{PROGRAMS}, @samp{LIBRARIES}, -@samp{SCRIPTS}, @samp{DATA}, and @samp{HEADERS}. - -FIXME currently TEXINFOS and MANS don't follow this rule, but they -probably should. +@samp{SCRIPTS}, @samp{DATA}, @samp{HEADERS}, @samp{MANS}, and +@samp{TEXINFOS}. @node Programs @@ -464,7 +462,9 @@ texinfos-vars.am texinfos.am hack-make.sed nl-remove.sed @subsection Texinfo If the current directory contains Texinfo source, you must declare it -with the @samp{TEXINFOS} macro. +with the @samp{TEXINFOS} primary. Generally Texinfo files are converted +into info, and thus the @samp{info_TEXINFOS} macro is most commonly used +here. Note that any Texinfo source file must end in the @file{.texi} extension (@file{.texinfo} won't work). @@ -485,7 +485,7 @@ file. For instance, in the @samp{xdvik} distribution, variable. Here is how @samp{xdvik} could do it: @example -TEXINFOS = kpathsea.texi +info_TEXINFOS = kpathsea.texi kpathsea_TEXINFOS = install.texi copying.texi freedom.texi @end example @@ -499,11 +499,22 @@ This restriction will be lifted if it proves too onerous. not also contain the file @file{texinfo.tex}. (I'm not sure if this is a good rule or not. Comments?) +In the future, @code{automake} will probably be modified to support +generating @samp{HTML} from Texinfo source. + @subsection Man pages A package can also include man pages. (Though see the GNU standards on this matter. FIXME xref). -Man pages are declared using the @samp{MANS} macro. +Man pages are declared using the @samp{MANS} primary. Generally the +@samp{man_MANS} macro is used. + +By default, man pages are installed by @code{make install}. However, +since the GNU project does not require man pages, many maintainers do +not expend effort to keep the man pages up to date. In these cases, the +@samp{no-installman} option will prevent the man pages from being +installed by default. (The user can still install them via +@code{make install-man}) Here is how the documentation is handled in GNU @code{cpio} (which includes @@ -817,7 +828,17 @@ Here are some things that might happen in the future: @itemize @bullet @item -Better error checking would be good. +Better error checking would be good. Automake has been moving in this +direction for a while. + +@item +The manual could stand updating. + +@item +HTML support. + +@item +The output will be cleaned up. @end itemize @node Some index diff --git a/version.texi b/version.texi index 3a72102..3acc1cd 100644 --- a/version.texi +++ b/version.texi @@ -1,3 +1,3 @@ -@set UPDATED 13 January +@set UPDATED 22 January @set EDITION 0.29 @set VERSION 0.29 -- 2.7.4