| John Thompson | 02bad9f | 2013-09-23 17:57:00 +0000 | [diff] [blame] | 1 | ================ |
| John Thompson | 26ecaf9 | 2013-10-16 13:44:21 +0000 | [diff] [blame] | 2 | Modularize Usage |
| John Thompson | 02bad9f | 2013-09-23 17:57:00 +0000 | [diff] [blame] | 3 | ================ |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 4 | |
| John Thompson | 469bbc0 | 2015-02-12 16:22:09 +0000 | [diff] [blame^] | 5 | ``modularize [<modularize-options>] <include-files-list>[,<include-files-list>]* |
| 6 | [<front-end-options>...]`` |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 7 | |
| 8 | ``<modularize-options>`` is a place-holder for options |
| 9 | specific to modularize, which are described below in |
| 10 | `Modularize Command Line Options`. |
| 11 | |
| 12 | ``<include-files-list>`` specifies the path of a file name for a |
| 13 | file containing the newline-separated list of headers to check |
| 14 | with respect to each other. Lines beginning with '#' and empty |
| 15 | lines are ignored. Header file names followed by a colon and |
| 16 | other space-separated file names will include those extra files |
| 17 | as dependencies. The file names can be relative or full paths, |
| John Thompson | 02bad9f | 2013-09-23 17:57:00 +0000 | [diff] [blame] | 18 | but must be on the same line. For example:: |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 19 | |
| John Thompson | 02bad9f | 2013-09-23 17:57:00 +0000 | [diff] [blame] | 20 | header1.h |
| 21 | header2.h |
| 22 | header3.h: header1.h header2.h |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 23 | |
| John Thompson | 26ecaf9 | 2013-10-16 13:44:21 +0000 | [diff] [blame] | 24 | Note that unless a ``-prefix (header path)`` option is specified, |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 25 | non-absolute file paths in the header list file will be relative |
| 26 | to the header list file directory. Use -prefix to specify a different |
| 27 | directory. |
| 28 | |
| 29 | ``<front-end-options>`` is a place-holder for regular Clang |
| 30 | front-end arguments, which must follow the <include-files-list>. |
| 31 | Note that by default, the underlying Clang front end assumes .h files |
| 32 | contain C source, so you might need to specify the ``-x c++`` Clang option |
| 33 | to tell Clang that the header contains C++ definitions. |
| 34 | |
| 35 | Modularize Command Line Options |
| John Thompson | 02bad9f | 2013-09-23 17:57:00 +0000 | [diff] [blame] | 36 | =============================== |
| John Thompson | 2d2d45e | 2013-09-20 14:40:52 +0000 | [diff] [blame] | 37 | |
| 38 | .. option:: -prefix <header-path> |
| 39 | |
| 40 | Prepend the given path to non-absolute file paths in the header list file. |
| 41 | By default, headers are assumed to be relative to the header list file |
| John Thompson | 26ecaf9 | 2013-10-16 13:44:21 +0000 | [diff] [blame] | 42 | directory. Use ``-prefix`` to specify a different directory. |
| 43 | |
| 44 | .. option:: -module-map-path=<module-map-path> |
| 45 | |
| 46 | Generate a module map and output it to the given file. See the description |
| 47 | in :ref:`module-map-generation`. |
| 48 | |
| 49 | .. option:: -root-module=<root-name> |
| 50 | |
| 51 | Put modules generated by the -module-map-path option in an enclosing |
| 52 | module with the given name. See the description in :ref:`module-map-generation`. |
| John Thompson | ecd3b04 | 2015-02-11 16:58:36 +0000 | [diff] [blame] | 53 | |
| 54 | .. option:: -block-check-header-list-only |
| 55 | |
| 56 | Limit the #include-inside-extern-or-namespace-block |
| 57 | check to only those headers explicitly listed in the header list. |
| 58 | This is a work-around for avoiding error messages for private includes that |
| 59 | purposefully get included inside blocks. |