From: W. Trevor King <wking@drexel.edu>
Date: Fri, 22 Oct 2010 14:18:11 +0000 (-0400)
Subject: Document command line overrides for built documentation.
X-Git-Tag: 1.0.0~3^2~10
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=45aa9980e13dab6d47bbe4a6077dcf99d337bd5c;p=be.git

Document command line overrides for built documentation.
---

diff --git a/doc/install.txt b/doc/install.txt
index 7278c01..5752566 100644
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -54,7 +54,24 @@ to install BE.  By default BE will install into your home directory,
 but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
 to another location.
 
+By default, ``make`` builds both a man page for ``be`` and the HTML
+Sphinx documentation (:doc:`doc`).  You can customize the
+documentation targets by overriding_ the ``DOC`` variable.  For
+example, to disable all documentation during a build/install, run::
+
+    $ make DOC= install
+
+Note that ``setup.py`` (called during ``make install``) will install
+the man page (``doc/man/be.1``) if it exists, so::
+
+    $ make
+    $ make DOC= install
+
+*will* build (first ``make``) install (second ``make``) the man page.
+
+
 .. _homepage: http://bugseverywhere.org/
+.. _overriding: http://www.gnu.org/software/make/manual/html_node/Overriding.html#Overriding
 
 
 Release tarballs