Re: [autoconf] doc dirs?

[Rüdiger Kuhlmann]

Hi!

>--[Russ Allbery]--<address@hidden>
> Rüdiger Kuhlmann <address@hidden> writes:

> > I'd like to re-kindle the discussion about options for where to put a
> > programs documentation by suggesting the following patch:
> Wouldn't some sort of general facility for adding a new *dir switch for a
> given package be better than adding a bunch of new options that very few
> packages will use (and making --help even longer)?  If the worry is that
> programs will use inconsistent switch names, we can always put a list of
> recommendations into the manual.

Probably a good idea, though I'd like to have a docdir anyway. Even if it
ends up beeing just another recommendation.

>--[Guido Draheim]--<address@hidden>
> Rüdiger Kuhlmann wrote:
> >  AC_SUBST([infodir],        ['${prefix}/info'])dnl
> > +AC_SUBST([htmldir],        ['${prefix}/share/doc/html'])dnl
> > +AC_SUBST([psdir],          ['${prefix}/share/doc/ps'])dnl
> > +AC_SUBST([dvidir],         ['${prefix}/share/doc/dvi'])dnl
> > +AC_SUBST([guidedir],       ['${prefix}/share/doc/guide'])dnl
> >  AC_SUBST([mandir],         ['${prefix}/man'])dnl
> From my experiences, these docs go usually just into $pkgdocdir, as
> unlike info/man there is no implicit directory-search/dirindex-build
> by the systemtools.

What is $pkgdocdir? Are you sure this does apply only to man files
considering that you can make man pop up your manual in ps dvi html
Amigaguide if it is available (and all four can be derived from texinfo)?

> Still, $docdir is missing and desperatly needed - 
> some  packagers/distmakers like to have the genericdocs/packagedocs
> to live in $prefix/doc (fhs1?), other systems (fhs2?) have them
> in $datadir/doc, or even in a Desktop/Documentation-subdir. 
> A $docdir should be settable on its own, yes it should...

Okay, what about this:

2001-06-19 Rüdiger Kuhlmann <address@hidden>
 
        * acgeneral.m4: (_AC_INIT_PARSE_ARGS) Add switch for
        directory for documentation in e.g. html, ps, dvi, guide format.
        * doc/autoconf.texi: Document docdir.

Index: acgeneral.m4
===================================================================
RCS file: /cvs/autoconf/acgeneral.m4,v
retrieving revision 1.735
diff -u -r1.735 acgeneral.m4
--- acgeneral.m4        2001/06/17 18:14:28     1.735
+++ acgeneral.m4        2001/06/19 23:33:30
@@ -701,6 +701,7 @@
 AC_SUBST([includedir],     ['${prefix}/include'])dnl
 AC_SUBST([oldincludedir],  ['/usr/include'])dnl
 AC_SUBST([infodir],        ['${prefix}/info'])dnl
+AC_SUBST([docdir],         ['${datadir}/doc'])dnl
 AC_SUBST([mandir],         ['${prefix}/man'])dnl
 
 # Identity of this package.
@@ -814,6 +815,11 @@
   -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*)
     infodir=$ac_optarg ;;
 
+  -docdir | --docdir | --docdi | --docld | --doc)
+    ac_prev=docdir ;;
+  -docdir=* | --docdir=* | --docdi=* | --docd=* | --doc=*)
+    docdir="$ac_optarg" ;;
+
   -libdir | --libdir | --libdi | --libd)
     ac_prev=libdir ;;
   -libdir=* | --libdir=* | --libdi=* | --libd=*)
@@ -1025,7 +1031,7 @@
 
 # Be sure to have absolute paths.
 for ac_var in bindir sbindir libexecdir datadir sysconfdir sharedstatedir \
-              localstatedir libdir includedir oldincludedir infodir mandir
+              localstatedir libdir includedir oldincludedir infodir mandir 
docdir
 do
   eval ac_val=$`echo $ac_var`
   case $ac_val in
@@ -1123,6 +1129,7 @@
   --includedir=DIR       C header files [PREFIX/include]
   --oldincludedir=DIR    C header files for non-gcc [/usr/include]
   --infodir=DIR          info documentation [PREFIX/info]
+  --docdir=DIR           documentation in (subdirectory of) DIR [DATADIR/doc]
   --mandir=DIR           man documentation [PREFIX/man]
 EOF
 
Index: doc/autoconf.texi
===================================================================
RCS file: /cvs/autoconf/doc/autoconf.texi,v
retrieving revision 1.473
diff -u -r1.473 autoconf.texi
--- doc/autoconf.texi   2001/06/19 17:40:05     1.473
+++ doc/autoconf.texi   2001/06/19 23:42:37
@@ -1993,6 +1993,13 @@
 The directory for installing documentation in Info format.
 @end defvar
 
address@hidden docdir
address@hidden docdir
+The directory for installing documentation in other formats; use a
+subdirectory of its own for each format, e.g. put documentation in HTML
+format into @var{docdir}/html.
address@hidden defvar
+
 @defvar libdir
 @ovindex libdir
 The directory for installing object code libraries.



-- 
A "No" uttered from deepest conviction is better and greater than a
"Yes" merely uttered to please, or what is worse, to avoid trouble.
                -- Mahatma Ghandi