[all-commits] [llvm/llvm-project] 799b6b: [clang][docs] Use `option` directive in User's Manual
KAWASHIMA Takahiro via All-commits
all-commits at lists.llvm.org
Mon Nov 21 17:43:03 PST 2022
Branch: refs/heads/main
Home: https://github.com/llvm/llvm-project
Commit: 799b6b9f3193bd8a4499da063dc7f74cfccadefd
https://github.com/llvm/llvm-project/commit/799b6b9f3193bd8a4499da063dc7f74cfccadefd
Author: KAWASHIMA Takahiro <t-kawashima at fujitsu.com>
Date: 2022-11-22 (Tue, 22 Nov 2022)
Changed paths:
M clang/docs/OpenCLSupport.rst
M clang/docs/UsersManual.rst
Log Message:
-----------
[clang][docs] Use `option` directive in User's Manual
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.
Differential Revision: https://reviews.llvm.org/D138088
Commit: 2a0919b965b88080ef67fdffe57d3fa8d865d885
https://github.com/llvm/llvm-project/commit/2a0919b965b88080ef67fdffe57d3fa8d865d885
Author: KAWASHIMA Takahiro <t-kawashima at fujitsu.com>
Date: 2022-11-22 (Tue, 22 Nov 2022)
Changed paths:
M clang/docs/UsersManual.rst
Log Message:
-----------
[clang][docs] Remove an unnecessary space
Commit: 93591851d8416b64ee756a87508add76da2395aa
https://github.com/llvm/llvm-project/commit/93591851d8416b64ee756a87508add76da2395aa
Author: KAWASHIMA Takahiro <t-kawashima at fujitsu.com>
Date: 2022-11-22 (Tue, 22 Nov 2022)
Changed paths:
M clang/docs/UsersManual.rst
Log Message:
-----------
[clang][docs] Correct indent of option explanation
Indentation is significant for Sphinx. Lines with indentation after
a `.. option::` line are treated as explanations of the option.
Compare: https://github.com/llvm/llvm-project/compare/793ff082da87...93591851d841
More information about the All-commits
mailing list