aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManuel Klimek <klimek@google.com>2012-07-10 08:05:54 +0000
committerManuel Klimek <klimek@google.com>2012-07-10 08:05:54 +0000
commit3f6d513d51a382371669f4d0b943fa830fffeef2 (patch)
tree0bf07bf8249a1c7cf1dca97753e5a50dfbf6c13b
parentf6385a5d48fb5f17cf7c8d0426a75ab7112a8402 (diff)
Update the docs with specifics about escaping of compile commands.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@159987 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/JSONCompilationDatabase.html4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/JSONCompilationDatabase.html b/docs/JSONCompilationDatabase.html
index 9785ac48ba..2907194729 100644
--- a/docs/JSONCompilationDatabase.html
+++ b/docs/JSONCompilationDatabase.html
@@ -71,7 +71,9 @@ command objects for the same file, for example if the same source file is
compiled with different configurations.</li>
<li><b>command:</b> The compile command executed. After JSON unescaping, this must
be a valid command to rerun the exact compilation step for the translation unit in
-the environment the build system uses.</li>
+the environment the build system uses. Parameters use shell quoting and shell escaping
+of quotes, with '"' and '\' being the only special characters. Shell expansion is
+not supported.</li>
</ul>
</p>