Re: [PATCH] Mention install-doc in INSTALL

From

Petr Baudis <pasky@suse.cz>

Date

Jan 22, 2006, 00:12 UTC

Message-ID

<20060122001255.GR28365@pasky.or.cz>

In-Reply-To

<E1F0SYe-0005ix-WB@puzzle.fieldses.org>

> I think most people will want to install the man pages as well.
> 
> (I'm less sure about the case of the home directory, as I assume there's
> unlikely to be a reasonable place to install man pages to in that case.)
> 
> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>

diff --git a/INSTALL b/INSTALL
index 916ddd4..464bfbb 100644
--- a/INSTALL
+++ b/INSTALL
@@ -90,3 +90,10 @@ Issues of note:
    You can place local settings in config.mak and the Makefile
    will include them.  Note that config.mak is not distributed;
    the name is reserved for local settings.
+
+ - By default, separate documentation (manpages, text, HTML) is not built
+   since it requires asciidoc and xmlto, and those tools are not so common.
+   You can build it by "make doc" and install it later by "make install-doc"
+   in the project root, or you can build directly in the "Documentation/"
+   subdirectory, where you can also choose to build only documentation in
+   particular format. See Documentation/Makefile for further details.

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
Of the 3 great composers Mozart tells us what it's like to be human,
Beethoven tells us what it's like to be Beethoven and Bach tells us
what it's like to be the universe.  -- Douglas Adams