r256287 - Document that we recommend to turn off -gmodules when building a static

[Adrian Prantl via cfe-commits]

Author: adrian
Date: Tue Dec 22 16:37:22 2015
New Revision: 256287

URL: http://llvm.org/viewvc/llvm-project?rev=256287&view=rev
Log:
Document that we recommend to turn off -gmodules when building a static
library for distribution to other machines on the clang man page.

Modified:
    cfe/trunk/docs/CommandGuide/clang.rst

Modified: cfe/trunk/docs/CommandGuide/clang.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/CommandGuide/clang.rst?rev=256287&r1=256286&r2=256287&view=diff
==============================================================================
--- cfe/trunk/docs/CommandGuide/clang.rst (original)
+++ cfe/trunk/docs/CommandGuide/clang.rst Tue Dec 22 16:37:22 2015
@@ -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