Edit RST docs on building RST docs
authorGreg Hudson <ghudson@mit.edu>
Sat, 31 Mar 2012 06:01:02 +0000 (06:01 +0000)
committerGreg Hudson <ghudson@mit.edu>
Sat, 31 Mar 2012 06:01:02 +0000 (06:01 +0000)
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.

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25798 dc483132-0cff-0310-8789-dd5450dbe970

doc/rst_source/relay/build_this.rst

index d91a6d55d6100db8b4a4dab6f66f4f34238e2001..f51d1047dff591fa82b6ef0f146591c8026af45f 100644 (file)
@@ -29,10 +29,12 @@ expected.
 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 @@ Building for a release tarball or web site
 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.