svn rev #25798: trunk/doc/rst_source/relay/

ghudson@MIT.EDU ghudson at MIT.EDU
Sat Mar 31 02:01:03 EDT 2012


http://src.mit.edu/fisheye/changelog/krb5/?cs=25798
Commit By: ghudson
Log Message:
Edit RST docs on building RST docs

Fix a couple of grammar errors noted by Ben Kaduk, and elaborate a
little bit on why generated man pages are checked into the repository.


Changed Files:
U   trunk/doc/rst_source/relay/build_this.rst
Modified: trunk/doc/rst_source/relay/build_this.rst
===================================================================
--- trunk/doc/rst_source/relay/build_this.rst	2012-03-31 00:38:20 UTC (rev 25797)
+++ trunk/doc/rst_source/relay/build_this.rst	2012-03-31 06:01:02 UTC (rev 25798)
@@ -29,10 +29,12 @@
 Updating man pages
 ------------------
 
-Man pages generated from the RST sources, are checked into the src/man
-directory.  To regenerate these files, run ``make rstman`` from the
-man subdirectory of a configured build tree.  You can also do this
-from an unconfigured source tree with::
+Man pages are generated from the RST sources and checked into the
+``src/man`` directory of the repository.  This allows man pages to be
+installed without requiring Sphinx when using a source checkout.  To
+regenerate these files, run ``make rstman`` from the man subdirectory
+of a configured build tree.  You can also do this from an unconfigured
+source tree with::
 
     cd src/man
     make -f Makefile.in top_srcdir=.. srcdir=. rstman
@@ -48,7 +50,7 @@
 To generate documentation in HTML format, run ``make rsthtml`` in the
 ``doc`` subdirectory of a configured build tree (the build directory
 corresponding to ``src/doc``, not the top-level ``doc`` directory).
-The output be placed in the top-level ``doc/rst_html`` directory.
+The output will be placed in the top-level ``doc/rst_html`` directory.
 This build will include the API reference generated from Doxygen
 markup in the source tree.
 



More information about the cvs-krb5 mailing list