[PATCH] D90186: [TableGen] Update xxx-tblgen command document

Aaron Puchert via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Mar 29 15:58:06 PDT 2021


aaronpuchert added a comment.

In D90186#2657045 <https://reviews.llvm.org/D90186#2657045>, @Paul-C-Anagnostopoulos wrote:

> The problem is all the common options. You know if we repeat those in three places they will quickly become inconsistent.

Agreed, we don't want to duplicate them.

> What if I add two short documents that simply refer to the primary one? Then at least a clang or mlir developer will find those documents in the appropriate docs/commandguide directory and know to update the primary document.

Or even three? One for each variant (`{llvm,clang,mlir}-tblgen`), and one for the common options (let's say `tblgen`).

> Should I call them clang-tblgen.rst and mlir-tblgen.rst?

Yes, having the same name as the commands should make them easy to find. On Linux at least this is installed as man page and it's a rule that man pages should be named like the command.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D90186



More information about the llvm-commits mailing list