-
Notifications
You must be signed in to change notification settings - Fork 14.9k
[clang][docs] Fix typos in option names #163482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[clang][docs] Fix typos in option names #163482
Conversation
@llvm/pr-subscribers-clang Author: KAWASHIMA Takahiro (kawashima-fj) ChangesIf you type option names in the currnet Clang Compiler User's Manual, you'll see: $ clang -fnobasic-block-address-map -fnounique-internal-linkage-names -f-split-lto-unit test.c
clang: error: unknown argument '-fnobasic-block-address-map'; did you mean '-fno-basic-block-address-map'?
clang: error: unknown argument '-fnounique-internal-linkage-names'; did you mean '-fno-unique-internal-linkage-names'?
clang: error: unknown argument '-f-split-lto-unit'; did you mean '-fsplit-lto-unit'? Full diff: https://github.com/llvm/llvm-project/pull/163482.diff 1 Files Affected:
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 01f0b27846f0b..e82b16f24c73f 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2325,7 +2325,7 @@ are listed below.
devirtualization and virtual constant propagation, for classes with
:doc:`hidden LTO visibility <LTOVisibility>`. Requires ``-flto``.
-.. option:: -f[no]split-lto-unit
+.. option:: -f[no-]split-lto-unit
Controls splitting the :doc:`LTO unit <LTOVisibility>` into regular LTO and
:doc:`ThinLTO` portions, when compiling with -flto=thin. Defaults to false
@@ -2518,7 +2518,7 @@ are listed below.
.. _funique_internal_linkage_names:
-.. option:: -f[no]-unique-internal-linkage-names
+.. option:: -f[no-]unique-internal-linkage-names
Controls whether Clang emits a unique (best-effort) symbol name for internal
linkage symbols. When this option is set, compiler hashes the main source
@@ -2539,7 +2539,7 @@ are listed below.
$ cd $P/bar && clang -c -funique-internal-linkage-names name_conflict.c
$ cd $P && clang foo/name_conflict.o && bar/name_conflict.o
-.. option:: -f[no]-basic-block-address-map:
+.. option:: -f[no-]basic-block-address-map:
Emits a ``SHT_LLVM_BB_ADDR_MAP`` section which includes address offsets for each
basic block in the program, relative to the parent function address.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/88/builds/17136 Here is the relevant piece of the build log for the reference
|
If you type option names in the currnet Clang Compiler User's Manual, you'll see: