summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/ModularizeUsage.rst
diff options
context:
space:
mode:
authorJohn Thompson <John.Thompson.JTSoftware@gmail.com>2013-10-16 13:44:21 +0000
committerJohn Thompson <John.Thompson.JTSoftware@gmail.com>2013-10-16 13:44:21 +0000
commit26ecaf95a29676ba83508b0ba78b4a6344138f8e (patch)
tree0cf4a9450f14f01dc989e096f286db48e19266be /clang-tools-extra/docs/ModularizeUsage.rst
parentfa103da8676d87bcb59432c68bb1f8686f9cd47b (diff)
downloadbcm5719-llvm-26ecaf95a29676ba83508b0ba78b4a6344138f8e.tar.gz
bcm5719-llvm-26ecaf95a29676ba83508b0ba78b4a6344138f8e.zip
Added module map generation docs and some clean-up.
llvm-svn: 192792
Diffstat (limited to 'clang-tools-extra/docs/ModularizeUsage.rst')
-rw-r--r--clang-tools-extra/docs/ModularizeUsage.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/clang-tools-extra/docs/ModularizeUsage.rst b/clang-tools-extra/docs/ModularizeUsage.rst
index 64c89ed50bc..dc335431ba7 100644
--- a/clang-tools-extra/docs/ModularizeUsage.rst
+++ b/clang-tools-extra/docs/ModularizeUsage.rst
@@ -1,5 +1,5 @@
================
-modularize Usage
+Modularize Usage
================
``modularize [<modularize-options>] <include-files-list> [<front-end-options>...]``
@@ -20,7 +20,7 @@ but must be on the same line. For example::
header2.h
header3.h: header1.h header2.h
-Note that unless a "-prefix (header path)" option is specified,
+Note that unless a ``-prefix (header path)`` option is specified,
non-absolute file paths in the header list file will be relative
to the header list file directory. Use -prefix to specify a different
directory.
@@ -38,4 +38,14 @@ Modularize Command Line Options
Prepend the given path to non-absolute file paths in the header list file.
By default, headers are assumed to be relative to the header list file
- directory. Use -prefix to specify a different directory.
+ directory. Use ``-prefix`` to specify a different directory.
+
+.. option:: -module-map-path=<module-map-path>
+
+ Generate a module map and output it to the given file. See the description
+ in :ref:`module-map-generation`.
+
+.. option:: -root-module=<root-name>
+
+ Put modules generated by the -module-map-path option in an enclosing
+ module with the given name. See the description in :ref:`module-map-generation`.
OpenPOWER on IntegriCloud