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

Mon Jan 17 00:34:55 PST 2022

hokein accepted this revision.
hokein added inline comments.
This revision is now accepted and ready to land.

================
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.
----------------
sammccall wrote:
> 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.
yeah, the `arguments` was added 7 years ago, and most of tools are still generating `command`...

Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D117428