summaryrefslogtreecommitdiff
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorAdrian Prantl <aprantl@apple.com>2015-12-22 22:37:22 +0000
committerAdrian Prantl <aprantl@apple.com>2015-12-22 22:37:22 +0000
commit2f39eb6689a0e70e5c81d0f5c910497e08ec0a8a (patch)
treefb57e73a9d8f525861203f8efc285a7d84961496 /docs/CommandGuide
parent1d0506e00b6d66aee08f2776cf586b58bbf97e55 (diff)
downloadclang-2f39eb6689a0e70e5c81d0f5c910497e08ec0a8a.tar.gz
Document that we recommend to turn off -gmodules when building a static
library for distribution to other machines on the clang man page. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@256287 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/clang.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/CommandGuide/clang.rst b/docs/CommandGuide/clang.rst
index 9f6d6f588e..2b4569592a 100644
--- a/docs/CommandGuide/clang.rst
+++ b/docs/CommandGuide/clang.rst
@@ -262,7 +262,12 @@ Code Generation Options
Generate debug information that contains external references to
types defined in clang modules or precompiled headers instead of
emitting redundant debug type information into every object file.
- This option implies `-fmodule-format=obj`.
+ This option implies :option:`-fmodule-format=obj`.
+
+ This option should not be used when building static libraries for
+ distribution to other machines because the debug info will contain
+ references to the module cache on the machine the object files in
+ the library were built on.
.. option:: -fstandalone-debug -fno-standalone-debug