<<< Date Index >>>     <<< Thread Index >>>

[PATCH] avoid full documentation



The manual has many unsupported variables.
It is really confusing when you are trying to use
an unfamiliar feature.

For example, you can't distinguish OpenSSL variables
from GNUTLS variables without grepping init.h.
I was surprised when the manual told me there was
$ssl_ca_certificates_file, but it turned out to have
been disabled because I didn't have GNUTLS.

So, even if xsltproc complains, I want to have "my"
manual. And perhaps most packagers do, too.
(Many users would shout "my mutt doesn't have
$ssl_ca_certificates_file! I wanna use SSL!"
and fill their bugtrackers.)

-- 
tamo
diff -r 5ea9f336dd60 configure.ac
--- a/configure.ac      Mon Oct 20 11:50:38 2008 -0700
+++ b/configure.ac      Thu Oct 23 14:19:27 2008 +0900
@@ -1289,6 +1289,16 @@
 fi
 AC_SUBST(DSLROOT)
 
+AC_ARG_ENABLE(full_doc,
+             AC_HELP_STRING([--disable-full-doc], [Omit disabled variables]),
+[       if test x$enableval = xno ; then
+                full_doc=no
+        fi
+])
+if test x$full_doc != xno ; then
+  AC_DEFINE(MAKEDOC_FULL,1, [Define if you want complete documentation.])
+fi
+
 AC_OUTPUT(Makefile contrib/Makefile doc/Makefile imap/Makefile
         intl/Makefile m4/Makefile po/Makefile.in
         hcachever.sh muttbug.sh doc/instdoc.sh)
diff -r 5ea9f336dd60 doc/makedoc-defs.h
--- a/doc/makedoc-defs.h        Mon Oct 20 11:50:38 2008 -0700
+++ b/doc/makedoc-defs.h        Thu Oct 23 14:19:28 2008 +0900
@@ -1,5 +1,6 @@
 /* build complete documentation */
 
+#ifdef MAKEDOC_FULL
 # ifndef CRYPT_BACKEND_GPGME
 #  define CRYPT_BACKEND_GPGME
 # endif
@@ -54,3 +55,4 @@
 # ifndef USE_SASL
 #  define USE_SASL
 # endif
+#endif