[llvm-commits] [lld] r154229 - /lld/trunk/docs/sphinx_intro.rst

[Daniel Dunbar]

Author: ddunbar
Date: Fri Apr  6 18:55:50 2012
New Revision: 154229

URL: http://llvm.org/viewvc/llvm-project?rev=154229&view=rev
Log:
[docs] Note that 'make.bat' provides the same interface as the Makefile for
Windows users.

Modified:
    lld/trunk/docs/sphinx_intro.rst

Modified: lld/trunk/docs/sphinx_intro.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/sphinx_intro.rst?rev=154229&r1=154228&r2=154229&view=diff
==============================================================================
--- lld/trunk/docs/sphinx_intro.rst (original)
+++ lld/trunk/docs/sphinx_intro.rst Fri Apr  6 18:55:50 2012
@@ -63,9 +63,13 @@
   $ cd path/to/project/docs
   $ make html
 
-which will invoke ``sphinx-build`` with the appropriate options for the project,
-and generate the HTML documentation in a ``_build`` subdirectory. You can browse
-it starting from the index page by visiting ``_build/html/index.html``.
+Note that on Windows there is a ``make.bat`` command in the docs directory which
+supplies the same interface as the ``Makefile``.
+
+That command will invoke ``sphinx-build`` with the appropriate options for the
+project, and generate the HTML documentation in a ``_build`` subdirectory. You
+can browse it starting from the index page by visiting
+``_build/html/index.html``.
 
 Sphinx supports a wide variety of generation formats (including LaTeX, man
 pages, and plain text). The ``Makefile`` includes a number of convenience
@@ -74,10 +78,10 @@
   make html
     Generate the HTML output.
 
-  latexpdf
+  make latexpdf
     Generate LaTeX documentation and convert to a PDF.
 
-  man
+  make man
     Generate man pages.