[PATCH] D117428: [docs] Clarify & update JSONCompilationDatabase docs

[Sam McCall via Phabricator via cfe-commits]

sammccall added inline comments.


================
Comment at: clang/docs/JSONCompilationDatabase.rst:95
+
+   Either **arguments** or **command** is required. **arguments** is preferred,
+   as shell (un)escaping is a possible source of errors.
----------------
Hopefully I'm not too far out on a limb here.

Today, `command` is generated by CMake & others. The shell unescaping performed is underspecified and platform-specific (`#if _WIN32 ... #else`). There are non-llvm consumers of this format (e.g. vscode-cpptools).

I think we're in danger of interop problems and gently encouraging migration to `arguments` reduces the danger.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D117428/new/

https://reviews.llvm.org/D117428