[PATCH] D152396: [clang][doc] Rescue some deleted bits of the command-line reference.

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Jun 8 04:54:23 PDT 2023


aaron.ballman added subscribers: jansvoboda11, MaskRay.
aaron.ballman added a comment.
Herald added a subscriber: bd1976llvm.

These changes LGTM, thank you!

@MaskRay, @jansvoboda11  -- I think we need to figure out a better strategy for documenting compiler options. We have documentation that lives here in `Options.td`, but we also have documentation in `UsersManual.rst`; it would be good for us to have a unified place for option documentation so users don't have to click around so much (and so we don't accidentally wind up with conflicting documentation in two places). My suggestion is that we use `Options.td` to generate all of the docs, and move what we've got in `UsersManual.rst` (and elsewhere, if we find it) into here. Additionally, I think we should take any long-form documentation and split it between `ClangOptionDocs.td` and `Options.td` similar to how we already do for `Attr.td` and `AttrDocs.td` or `Diagnostic*Kinds.td` and `DiagnosticDocs.td` (so the documentation is generated from a single source, but we don't have to clutter that file up with longer documentation strings). Finally, I think we should begin to require documentation for all new user-facing driver options as part of the code review process (we can even enforce this by failing a build if a driver option has no associated documentation, similar to how we do it for attributes; we use an `Undocumented` placeholder for all the existing options without documentation so those can be backfilled over time). WDYT?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D152396



More information about the cfe-commits mailing list