From: Daniel Dunbar <daniel@zuster.org>
Date: Thu, 3 Nov 2011 17:56:24 +0000 (+0000)
Subject: docs: Sketch docs for llvm-build tool.
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=2adb2a55ecfa276eaca7f05bc0c0dba4fdf1bed9;p=oota-llvm.git

docs: Sketch docs for llvm-build tool.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143627 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/CommandGuide/Makefile b/docs/CommandGuide/Makefile
index 2c2d0760e79..3f9f60b8e7f 100644
--- a/docs/CommandGuide/Makefile
+++ b/docs/CommandGuide/Makefile
@@ -49,7 +49,7 @@ MAN  := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD))
 PS   := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
 
 # The set of man pages we will not install
-NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1
+NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1 $(DST_MAN_DIR)llvm-build.1
 
 # The set of man pages that we will install
 INSTALL_MANS = $(filter-out $(NO_INSTALL_MANS), $(MAN))
diff --git a/docs/CommandGuide/llvm-build.pod b/docs/CommandGuide/llvm-build.pod
new file mode 100644
index 00000000000..6f70ffe32cf
--- /dev/null
+++ b/docs/CommandGuide/llvm-build.pod
@@ -0,0 +1,62 @@
+=pod
+
+=head1 NAME
+
+llvm-build - LLVM Project Build Utility
+
+=head1 SYNOPSIS
+
+B<llvm-build> [I<options>]
+
+=head1 DESCRIPTION
+
+B<llvm-build> is a tool for working with LLVM projects that use the LLVMBuild
+system for describing their components.
+
+At heart, B<llvm-build> is responsible for loading, verifying, and manipulating
+the project's component data. The tool is primarily designed for use in
+implementing build systems and tools which need access to the project structure
+information.
+
+=head1 OPTIONS
+
+=over
+
+=item B<-h>, B<--help>
+
+Print the builtin program help.
+
+=item B<--source-root>=I<PATH>
+
+If given, load the project at the given source root path. If this option is not
+given, the location of the project sources will be inferred from the location of
+the B<llvm-build> script itself.
+
+=item B<--print-tree>
+
+Print the component tree for the project.
+
+=item B<--write-llvmbuild>
+
+Write out new I<LLVMBuild.txt> files based on the loaded components. This is
+useful for auto-upgrading the schema of the files.
+
+=item B<--llvmbuild-source-root>=I<PATH>
+
+If given, expect the I<LLVMBuild> files for the project to be rooted at the
+given path, instead of inside the source tree itself. This option is primarily
+designed for use in conjunction with B<--write-llvmbuild> to test changes to
+I<LLVMBuild> schema.
+
+=back
+
+=head1 EXIT STATUS
+
+B<llvm-build> exits with 0 if operation was successful. Otherwise, it will exist
+with a non-zero value.
+
+=head1 AUTHOR
+
+Maintained by the LLVM Team (L<http://llvm.org/>).
+
+=cut
diff --git a/docs/LLVMBuild.html b/docs/LLVMBuild.html
index 904d0e56e41..bb1883a12c5 100644
--- a/docs/LLVMBuild.html
+++ b/docs/LLVMBuild.html
@@ -88,6 +88,11 @@ $ROOT of project trees for things which can be checked out separately. -->
   developers who are not working on the build system would only ever need to
   modify the contents of the <i>LLVMBuild.txt</i> description files (although we
   have not reached this goal yet).</p>
+
+  <p>For more information on the utility tool we provide to help interfacing
+  with the build system, please see
+  the <a href="CommandGuide/html/llvm-build.html">llvm-build</a>
+  documentation.</p>
 </div>
 
 <!-- *********************************************************************** -->