[PATCH] D133209: [clang] Document environment variables used by the driver

[Jan Svoboda via Phabricator via cfe-commits]

jansvoboda11 added inline comments.


================
Comment at: clang/docs/ClangCommandLineReference.rst:2-5
   -------------------------------------------------------------------
   NOTE: This file is automatically generated by running clang-tblgen
   -gen-opt-docs. Do not edit this file by hand!!
   -------------------------------------------------------------------
----------------
aaron.ballman wrote:
> mizvekov wrote:
> > aaron.ballman wrote:
> > > I think you might have missed this bit. ;-)
> > > 
> > > @jansvoboda11 -- do you know of an ergonomic way for people to associate extra documentation along with the command line reference to support adding documentation like this? This is the second time in the past hour I've seen people adding documentation directly to this file and the docs would be kind of onerous to put in `HelpText<>` directly. I'm wondering if the FE options can support something along the lines of AttrDocs.td where we can specify some out-of-line documentation in another .td for things that are nontrivial to document?
> > Ooops!
> > 
> > Why do we even commit this file then? :-)
> +1 -- we automatically generate the document from the cmake sphinx target, so I think it's reasonable to remove this file from version control (same as we did for AttributeReference.rst and DiagnosticReference.rst).
We don't have good place for extra documentation. Doing something similar to `AttrDocs.td` for command-line options is a good direction IMO.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D133209