Skip to content

Commit 11a09b4

Browse files
committed
[docs] Fix a couple of typos in command line flag help text and regenerate documentation.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@300270 91177308-0d34-0410-b5e6-96231b3b80d8
1 parent 66bf2b0 commit 11a09b4

File tree

2 files changed

+61
-15
lines changed

2 files changed

+61
-15
lines changed

docs/ClangCommandLineReference.rst

+57-11
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,10 @@ Specify comma-separated list of triples OpenMP offloading targets to be supporte
198198

199199
.. option:: -framework <arg>
200200

201+
.. option:: -frtlib-add-rpath, -fno-rtlib-add-rpath
202+
203+
Add -rpath with architecture-specific resource directory to the linker flags
204+
201205
.. option:: --gcc-toolchain=<arg>, -gcc-toolchain <arg>
202206

203207
Use the gcc toolchain at the given directory
@@ -238,6 +242,8 @@ Make the next included directory (-I or -F) an indexer header map
238242

239243
Run the migrator
240244

245+
.. option:: -mios-simulator-version-min=<arg>, -miphonesimulator-version-min=<arg>
246+
241247
.. option:: -mlinker-version=<arg>
242248

243249
.. option:: -mlittle-endian, -EL
@@ -250,6 +256,8 @@ Additional arguments to forward to LLVM's option processing
250256

251257
Directory to dump module dependencies to
252258

259+
.. option:: -mtvos-simulator-version-min=<arg>, -mappletvsimulator-version-min=<arg>
260+
253261
.. option:: -multi\_module
254262

255263
.. option:: -multiply\_defined <arg>
@@ -258,6 +266,8 @@ Directory to dump module dependencies to
258266
.. option:: -multiply\_defined\_unused <arg>
259267
.. program:: clang
260268

269+
.. option:: -mwatchos-simulator-version-min=<arg>, -mwatchsimulator-version-min=<arg>
270+
261271
.. option:: --no-cuda-version-check
262272

263273
Don't error out if the detected version of the CUDA install is too low for the requested CUDA gpu architecture.
@@ -416,6 +426,10 @@ Print the library path for the currently used compiler runtime library ("libgcc.
416426

417427
Print the full program path of <name>
418428

429+
.. option:: -print-resource-dir, --print-resource-dir
430+
431+
Print the resource directory pathname
432+
419433
.. option:: -print-search-dirs, --print-search-dirs
420434

421435
Print the paths used for finding libraries and programs
@@ -678,6 +692,8 @@ Inline functions which are (explicitly or implicitly) marked inline
678692

679693
.. option:: -fno-crash-diagnostics
680694

695+
Disable auto-generation of preprocessed source files and a script for reproduction during a clang crash
696+
681697
.. option:: -fno-sanitize-blacklist
682698

683699
Don't use blacklist file for sanitizers
@@ -872,6 +888,10 @@ Add directory to AFTER include search path
872888

873889
Add directory to SYSTEM framework search path
874890

891+
.. option:: -iframeworkwithsysroot<directory>
892+
893+
Add directory to SYSTEM framework search path, absolute paths are relative to -isysroot
894+
875895
.. option:: -imacros<file>, --imacros<file>, --imacros=<arg>
876896

877897
Include macros from file before parsing
@@ -1053,9 +1073,7 @@ Enable C++17 aligned allocation functions
10531073

10541074
.. option:: -fallow-unsupported
10551075

1056-
.. option:: -maltivec, -mno-altivec
1057-
1058-
Enable AltiVec vector initializer syntax
1076+
.. option:: -faltivec, -fno-altivec
10591077

10601078
.. option:: -fansi-escape-codes
10611079

@@ -1155,6 +1173,10 @@ Place each data in its own section (ELF Only)
11551173

11561174
Emit extra debug info to make sample profile more accurate.
11571175

1176+
.. option:: -fdebug-macro, -fno-debug-macro
1177+
1178+
Emit macro debug information
1179+
11581180
.. option:: -fdebug-pass-arguments
11591181

11601182
.. option:: -fdebug-pass-structure
@@ -1531,7 +1553,11 @@ Generate instrumented code to collect execution counts into <file> (overridden b
15311553

15321554
Use instrumentation data for profile-guided optimization
15331555

1556+
.. option:: -fprofile-sample-use, -fauto-profile, -fno-profile-sample-use
1557+
1558+
.. program:: clang1
15341559
.. option:: -fprofile-sample-use=<arg>, -fauto-profile=<arg>
1560+
.. program:: clang
15351561

15361562
Enable sample-based profile guided optimizations
15371563

@@ -1653,7 +1679,7 @@ Enable optimizations based on the strict definition of an enum's value range
16531679

16541680
.. option:: -fstrict-return, -fno-strict-return
16551681

1656-
Always treat control flow paths that fall off the end of a non-voidfunction as unreachable
1682+
Always treat control flow paths that fall off the end of a non-void function as unreachable
16571683

16581684
.. option:: -fstrict-vtable-pointers, -fno-strict-vtable-pointers
16591685

@@ -1765,6 +1791,10 @@ Treat signed integer overflow as two's complement
17651791

17661792
Store string literals as writable data
17671793

1794+
.. option:: -fxray-always-instrument=<arg>
1795+
1796+
Filename defining the whitelist for imbuing the 'always instrument' XRay attribute.
1797+
17681798
.. option:: -fxray-instruction-threshold<arg>
17691799

17701800
.. program:: clang1
@@ -1777,6 +1807,10 @@ Sets the minimum function size to instrument with XRay
17771807

17781808
Generate XRay instrumentation sleds on function entry and exit
17791809

1810+
.. option:: -fxray-never-instrument=<arg>
1811+
1812+
Filename defining the whitelist for imbuing the 'never instrument' XRay attribute.
1813+
17801814
.. option:: -fzero-initialized-in-bss, -fno-zero-initialized-in-bss
17811815

17821816
.. option:: -fzvector, -fno-zvector, -mzvector
@@ -1875,7 +1909,7 @@ Link stack frames through backchain on System Z
18751909

18761910
.. option:: -mconsole<arg>
18771911

1878-
.. option:: -mcpu=<arg>, -mv4 (equivalent to -mcpu=hexagonv4), -mv5 (equivalent to -mcpu=hexagonv5), -mv55 (equivalent to -mcpu=hexagonv55), -mv60 (equivalent to -mcpu=hexagonv60)
1912+
.. option:: -mcpu=<arg>, -mv4 (equivalent to -mcpu=hexagonv4), -mv5 (equivalent to -mcpu=hexagonv5), -mv55 (equivalent to -mcpu=hexagonv55), -mv60 (equivalent to -mcpu=hexagonv60), -mv62 (equivalent to -mcpu=hexagonv62)
18791913

18801914
.. option:: -mdll<arg>
18811915

@@ -1891,6 +1925,10 @@ Link stack frames through backchain on System Z
18911925

18921926
Set EABI type, e.g. 4, 5 or gnu (default depends on triple)
18931927

1928+
.. option:: -mfentry
1929+
1930+
Insert calls to fentry at function entry (x86 only)
1931+
18941932
.. option:: -mfloat-abi=<arg>
18951933

18961934
.. option:: -mfp32
@@ -1925,7 +1963,7 @@ Use Intel MCU ABI
19251963

19261964
(integrated-as) Emit an object file which can be used with an incremental linker
19271965

1928-
.. option:: -miphoneos-version-min=<arg>, -mios-simulator-version-min=<arg>, -mios-version-min=<arg>, -miphonesimulator-version-min=<arg>
1966+
.. option:: -miphoneos-version-min=<arg>, -mios-version-min=<arg>
19291967

19301968
.. option:: -mips16
19311969

@@ -2015,15 +2053,15 @@ The thread model to use, e.g. posix, single (posix by default)
20152053

20162054
.. option:: -mtune=<arg>
20172055

2018-
.. option:: -mtvos-version-min=<arg>, -mappletvos-version-min=<arg>, -mappletvsimulator-version-min=<arg>, -mtvos-simulator-version-min=<arg>
2056+
.. option:: -mtvos-version-min=<arg>, -mappletvos-version-min=<arg>
20192057

20202058
.. option:: -municode<arg>
20212059

20222060
.. option:: -mvx, -mno-vx
20232061

20242062
.. option:: -mwarn-nonportable-cfstrings, -mno-warn-nonportable-cfstrings
20252063

2026-
.. option:: -mwatchos-version-min=<arg>, -mwatchos-simulator-version-min=<arg>, -mwatchsimulator-version-min=<arg>
2064+
.. option:: -mwatchos-version-min=<arg>
20272065

20282066
.. option:: -mwindows<arg>
20292067

@@ -2065,6 +2103,10 @@ Disallow generation of data access to code sections (ARM only)
20652103

20662104
Disallow use of movt/movw pairs (ARM only)
20672105

2106+
.. option:: -mno-neg-immediates
2107+
2108+
Disallow converting instructions with negative immediates to their negation or inversion.
2109+
20682110
.. option:: -mnocrc
20692111

20702112
Disallow use of CRC instructions (ARM only)
@@ -2091,6 +2133,8 @@ Enable Hexagon Double Vector eXtensions
20912133

20922134
PowerPC
20932135
-------
2136+
.. option:: -maltivec, -mno-altivec
2137+
20942138
.. option:: -mcmpb, -mno-cmpb
20952139

20962140
.. option:: -mcrbits, -mno-crbits
@@ -2167,6 +2211,8 @@ X86
21672211

21682212
.. option:: -mclwb, -mno-clwb
21692213

2214+
.. option:: -mclzero, -mno-clzero
2215+
21702216
.. option:: -mcx16, -mno-cx16
21712217

21722218
.. option:: -mf16c, -mno-f16c
@@ -2491,15 +2537,15 @@ Add directory to library search path
24912537

24922538
Specify <script> as linker script
24932539

2494-
.. option:: -Tbss<addr
2540+
.. option:: -Tbss<addr>
24952541

24962542
Set starting address of BSS to <addr>
24972543

2498-
.. option:: -Tdata<addr
2544+
.. option:: -Tdata<addr>
24992545

25002546
Set starting address of BSS to <addr>
25012547

2502-
.. option:: -Ttext<addr
2548+
.. option:: -Ttext<addr>
25032549

25042550
Set starting address of BSS to <addr>
25052551

include/clang/Driver/Options.td

+4-4
Original file line numberDiff line numberDiff line change
@@ -402,11 +402,11 @@ def R_Joined : Joined<["-"], "R">, Group<R_Group>, Flags<[CC1Option, CoreOption]
402402
def S : Flag<["-"], "S">, Flags<[DriverOption,CC1Option]>, Group<Action_Group>,
403403
HelpText<"Only run preprocess and compilation steps">;
404404
def Tbss : JoinedOrSeparate<["-"], "Tbss">, Group<T_Group>,
405-
MetaVarName<"<addr">, HelpText<"Set starting address of BSS to <addr>">;
405+
MetaVarName<"<addr>">, HelpText<"Set starting address of BSS to <addr>">;
406406
def Tdata : JoinedOrSeparate<["-"], "Tdata">, Group<T_Group>,
407-
MetaVarName<"<addr">, HelpText<"Set starting address of BSS to <addr>">;
407+
MetaVarName<"<addr>">, HelpText<"Set starting address of BSS to <addr>">;
408408
def Ttext : JoinedOrSeparate<["-"], "Ttext">, Group<T_Group>,
409-
MetaVarName<"<addr">, HelpText<"Set starting address of BSS to <addr>">;
409+
MetaVarName<"<addr>">, HelpText<"Set starting address of BSS to <addr>">;
410410
def T : JoinedOrSeparate<["-"], "T">, Group<T_Group>,
411411
MetaVarName<"<script>">, HelpText<"Specify <script> as linker script">;
412412
def U : JoinedOrSeparate<["-"], "U">, Group<Preprocessor_Group>,
@@ -1908,7 +1908,7 @@ def mpie_copy_relocations : Flag<["-"], "mpie-copy-relocations">, Group<m_Group>
19081908
Flags<[CC1Option]>,
19091909
HelpText<"Use copy relocations support for PIE builds">;
19101910
def mno_pie_copy_relocations : Flag<["-"], "mno-pie-copy-relocations">, Group<m_Group>;
1911-
def mfentry : Flag<["-"], "mfentry">, HelpText<"insert calls to fentry at function entry (x86 only)">,
1911+
def mfentry : Flag<["-"], "mfentry">, HelpText<"Insert calls to fentry at function entry (x86 only)">,
19121912
Flags<[CC1Option]>, Group<m_Group>;
19131913
def mx87 : Flag<["-"], "mx87">, Group<m_x86_Features_Group>;
19141914
def m80387 : Flag<["-"], "m80387">, Alias<mx87>;

0 commit comments

Comments
 (0)