[PATCH] D138088: [clang][docs] Use `option` directive in User's Manual

KAWASHIMA Takahiro via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue Nov 15 20:50:43 PST 2022


kawashima-fj created this revision.
kawashima-fj added a project: clang.
Herald added a project: All.
kawashima-fj requested review of this revision.
Herald added a subscriber: cfe-commits.

Sphinx has the `option` directive. Most option descriptions in `clang/docs/UsersManual.rst` used it but some didn't. This commit changes the remaining option descriptions to use the `option` directive. This makes a consistent view in HTML.

The `option` directive automatically creates a cross-reference target. So labeling by `.. _opt_XXX:` is almost unnecessary. However, options with and without `no-` (e.g. `-fno-show-column`/`-fshow-column`) cannot be distinguish for the cross-reference. So some required `.. _opt_XXX:` directives are kept unremoved.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D138088

Files:
  clang/docs/OpenCLSupport.rst
  clang/docs/UsersManual.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D138088.475674.patch
Type: text/x-patch
Size: 15449 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20221116/1b96a68c/attachment-0001.bin>


More information about the cfe-commits mailing list