[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
hans added a comment. Thanks for polishing the UX! :-) CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
thakis closed this revision. thakis added a comment. r365721 CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
rnk accepted this revision. rnk added a comment. This revision is now accepted and ready to land. lgtm Comment at: clang/include/clang/Driver/CLCompatOptions.td:294 def _SLASH_GX : CLFlag<"GX">, - HelpText<"Enable exception handling">; + HelpText<"Deprecated (like /EHsc)">; def _SLASH_GX_ : CLFlag<"GX-">, thakis wrote: > rnk wrote: > > "Deprecated in favor of /EHsc"? or "(use /EHsc instead)"? > The other deprecated flags use "Deprecated (description); use /replacement". > Changed to "Deprecated; use /EHsc"; description and replacement are the same > here. (Except that /EH doesn't have a great help text atm.) CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
thakis updated this revision to Diff 209093. thakis marked 4 inline comments as done. thakis added a comment. comments CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 Files: clang/include/clang/Driver/CLCompatOptions.td Index: clang/include/clang/Driver/CLCompatOptions.td === --- clang/include/clang/Driver/CLCompatOptions.td +++ clang/include/clang/Driver/CLCompatOptions.td @@ -52,21 +52,21 @@ // already in the right group.) def _SLASH_Brepro : CLFlag<"Brepro">, - HelpText<"Emit an object file which can be reproduced over time">, + HelpText<"Do not write current time into COFF output (breaks link.exe /incremental)">, Alias; def _SLASH_Brepro_ : CLFlag<"Brepro-">, - HelpText<"Emit an object file which cannot be reproduced over time">, + HelpText<"Write current time into COFF output (default)">, Alias; def _SLASH_C : CLFlag<"C">, - HelpText<"Don't discard comments when preprocessing">, Alias; + HelpText<"Do not discard comments when preprocessing">, Alias; def _SLASH_c : CLFlag<"c">, HelpText<"Compile only">, Alias; def _SLASH_d1PP : CLFlag<"d1PP">, HelpText<"Retain macro definitions in /E mode">, Alias; def _SLASH_d1reportAllClassLayout : CLFlag<"d1reportAllClassLayout">, HelpText<"Dump record layout information">, -Alias, AliasArgs<["-fdump-record-layouts"]>; + Alias, AliasArgs<["-fdump-record-layouts"]>; def _SLASH_diagnostics_caret : CLFlag<"diagnostics:caret">, - HelpText<"Enable caret and column diagnostics (on by default)">; + HelpText<"Enable caret and column diagnostics (default)">; def _SLASH_diagnostics_column : CLFlag<"diagnostics:column">, HelpText<"Disable caret diagnostics but keep column info">; def _SLASH_diagnostics_classic : CLFlag<"diagnostics:classic">, @@ -83,12 +83,14 @@ def _SLASH_fp_strict : CLFlag<"fp:strict">, HelpText<"">, Alias; def _SLASH_GA : CLFlag<"GA">, Alias, AliasArgs<["local-exec"]>, HelpText<"Assume thread-local variables are defined in the executable">; -def _SLASH_GR : CLFlag<"GR">, HelpText<"Enable emission of RTTI data">; -def _SLASH_GR_ : CLFlag<"GR-">, HelpText<"Disable emission of RTTI data">; -def _SLASH_GF : CLIgnoredFlag<"GF">, HelpText<"Enable string pooling (default)">; +def _SLASH_GR : CLFlag<"GR">, HelpText<"Emit RTTI data (default)">; +def _SLASH_GR_ : CLFlag<"GR-">, HelpText<"Do not emit RTTI data">; +def _SLASH_GF : CLIgnoredFlag<"GF">, + HelpText<"Enable string pooling (default)">; def _SLASH_GF_ : CLFlag<"GF-">, HelpText<"Disable string pooling">, Alias; -def _SLASH_GS : CLFlag<"GS">, HelpText<"Enable buffer security check (default)">; +def _SLASH_GS : CLFlag<"GS">, + HelpText<"Enable buffer security check (default)">; def _SLASH_GS_ : CLFlag<"GS-">, HelpText<"Disable buffer security check">; def : CLFlag<"Gs">, HelpText<"Use stack probes (default)">, Alias, AliasArgs<["4096"]>; @@ -97,12 +99,12 @@ def _SLASH_Gy : CLFlag<"Gy">, HelpText<"Put each function in its own section">, Alias; def _SLASH_Gy_ : CLFlag<"Gy-">, - HelpText<"Don't put each function in its own section (default)">, + HelpText<"Do not put each function in its own section (default)">, Alias; def _SLASH_Gw : CLFlag<"Gw">, HelpText<"Put each data item in its own section">, Alias; def _SLASH_Gw_ : CLFlag<"Gw-">, - HelpText<"Don't put each data item in its own section">, + HelpText<"Do not put each data item in its own section (default)">, Alias; def _SLASH_help : CLFlag<"help">, Alias, HelpText<"Display available options">; @@ -121,13 +123,13 @@ // FIXME: Not sure why we have -O0 here; MSVC doesn't support that. def : CLFlag<"O0">, Alias, HelpText<"Disable optimization">; def : CLFlag<"O1">, Alias<_SLASH_O>, AliasArgs<["1"]>, - HelpText<"Optimize for size (same as /Og /Os /Oy /Ob2 /GF /Gy)">; + HelpText<"Optimize for size (like /Og /Os /Oy /Ob2 /GF /Gy)">; def : CLFlag<"O2">, Alias<_SLASH_O>, AliasArgs<["2"]>, - HelpText<"Optimize for speed (same as /Og /Oi /Ot /Oy /Ob2 /GF /Gy)">; + HelpText<"Optimize for speed (like /Og /Oi /Ot /Oy /Ob2 /GF /Gy)">; def : CLFlag<"Ob0">, Alias<_SLASH_O>, AliasArgs<["b0"]>, HelpText<"Disable function inlining">; def : CLFlag<"Ob1">, Alias<_SLASH_O>, AliasArgs<["b1"]>, - HelpText<"Only inline functions which are (explicitly or implicitly) marked inline">; + HelpText<"Only inline functions explicitly or implicitly marked inline">; def : CLFlag<"Ob2">, Alias<_SLASH_O>, AliasArgs<["b2"]>, HelpText<"Inline functions as deemed beneficial by the compiler">; def : CLFlag<"Od">, Alias<_SLASH_O>, AliasArgs<["d"]>, @@ -143,7 +145,7 @@ def : CLFlag<"Ot">, Alias<_SLASH_O>, AliasArgs<["t"]>, HelpText<"Optimize for speed">; def : CLFlag<"Ox">, Alias<_SLASH_O>, AliasArgs<["x"]>, - HelpText<"Deprecated (same as /Og /Oi /Ot /Oy /Ob2); use /O2 instead">; + HelpText<"Deprecated (like /Og /Oi /Ot /Oy /Ob2); use /O2">; def : CLFlag<"Oy">,
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
thakis added inline comments. Comment at: clang/include/clang/Driver/CLCompatOptions.td:250 def _SLASH_Zi : CLFlag<"Zi">, Alias<_SLASH_Z7>, - HelpText<"Alias for /Z7. Does not produce PDBs.">; + HelpText<"Like /Z7">; def _SLASH_Zp : CLJoined<"Zp">, rnk wrote: > I liked "Alias for /Z7". The note that it doesn't produce type server PDBs > like /Zi would is interesting, but perhaps too much info for --help text. "Alias" is a fairly technical word; I figured less jargon is maybe better. There's still plenty of jargon left :) Maybe "Same as /Z7"? (I went with "like" since that's what some of the parens say) Comment at: clang/include/clang/Driver/CLCompatOptions.td:294 def _SLASH_GX : CLFlag<"GX">, - HelpText<"Enable exception handling">; + HelpText<"Deprecated (like /EHsc)">; def _SLASH_GX_ : CLFlag<"GX-">, rnk wrote: > "Deprecated in favor of /EHsc"? or "(use /EHsc instead)"? The other deprecated flags use "Deprecated (description); use /replacement". Changed to "Deprecated; use /EHsc"; description and replacement are the same here. (Except that /EH doesn't have a great help text atm.) CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
rnk added inline comments. Comment at: clang/include/clang/Driver/CLCompatOptions.td:102 def _SLASH_Gy_ : CLFlag<"Gy-">, HelpText<"Don't put each function in its own section (default)">, Alias; ditto Comment at: clang/include/clang/Driver/CLCompatOptions.td:107 def _SLASH_Gw_ : CLFlag<"Gw-">, - HelpText<"Don't put each data item in its own section">, + HelpText<"Don't put each data item in its own section (default)">, Alias; Standardize on uncontracted "Do not"? Comment at: clang/include/clang/Driver/CLCompatOptions.td:250 def _SLASH_Zi : CLFlag<"Zi">, Alias<_SLASH_Z7>, - HelpText<"Alias for /Z7. Does not produce PDBs.">; + HelpText<"Like /Z7">; def _SLASH_Zp : CLJoined<"Zp">, I liked "Alias for /Z7". The note that it doesn't produce type server PDBs like /Zi would is interesting, but perhaps too much info for --help text. Comment at: clang/include/clang/Driver/CLCompatOptions.td:294 def _SLASH_GX : CLFlag<"GX">, - HelpText<"Enable exception handling">; + HelpText<"Deprecated (like /EHsc)">; def _SLASH_GX_ : CLFlag<"GX-">, "Deprecated in favor of /EHsc"? or "(use /EHsc instead)"? CHANGES SINCE LAST ACTION https://reviews.llvm.org/D64504/new/ https://reviews.llvm.org/D64504 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D64504: Various minor tweaks to CLCompatOptions.td
thakis created this revision. thakis added a reviewer: rnk. - Add back indentation I accidentally removed in r364901 - Wrap two lines to 80 cols - Slightly tighten up help text for several flags - Consistently use "Do not" instead of "Don't" - Make every option description start with a verb - Use "Set" instead of "Specify" - Mark default values of options more consistently - Remove text about "/Zi" not producing PDBs since it's confusing for people not intimately familiar with the implementation of the normal PDB pipeline. /Zi lets the linker produce PDBs, which is what most users want. - Consistently use "file" over "filename" in meta var names, consistently use "file name" over "filename" in text - Make all output setting options have consistent language Hopefully makes help output a bit easier to read. Also makes help for most flags in the "CL COMPAT FLAGS" section fit in an 80 column terminal. https://reviews.llvm.org/D64504 Files: clang/include/clang/Driver/CLCompatOptions.td Index: clang/include/clang/Driver/CLCompatOptions.td === --- clang/include/clang/Driver/CLCompatOptions.td +++ clang/include/clang/Driver/CLCompatOptions.td @@ -52,21 +52,21 @@ // already in the right group.) def _SLASH_Brepro : CLFlag<"Brepro">, - HelpText<"Emit an object file which can be reproduced over time">, + HelpText<"Do not write current time into COFF output (breaks link.exe /incremental)">, Alias; def _SLASH_Brepro_ : CLFlag<"Brepro-">, - HelpText<"Emit an object file which cannot be reproduced over time">, + HelpText<"Write current time into COFF output (default)">, Alias; def _SLASH_C : CLFlag<"C">, - HelpText<"Don't discard comments when preprocessing">, Alias; + HelpText<"Do not discard comments when preprocessing">, Alias; def _SLASH_c : CLFlag<"c">, HelpText<"Compile only">, Alias; def _SLASH_d1PP : CLFlag<"d1PP">, HelpText<"Retain macro definitions in /E mode">, Alias; def _SLASH_d1reportAllClassLayout : CLFlag<"d1reportAllClassLayout">, HelpText<"Dump record layout information">, -Alias, AliasArgs<["-fdump-record-layouts"]>; + Alias, AliasArgs<["-fdump-record-layouts"]>; def _SLASH_diagnostics_caret : CLFlag<"diagnostics:caret">, - HelpText<"Enable caret and column diagnostics (on by default)">; + HelpText<"Enable caret and column diagnostics (default)">; def _SLASH_diagnostics_column : CLFlag<"diagnostics:column">, HelpText<"Disable caret diagnostics but keep column info">; def _SLASH_diagnostics_classic : CLFlag<"diagnostics:classic">, @@ -83,12 +83,14 @@ def _SLASH_fp_strict : CLFlag<"fp:strict">, HelpText<"">, Alias; def _SLASH_GA : CLFlag<"GA">, Alias, AliasArgs<["local-exec"]>, HelpText<"Assume thread-local variables are defined in the executable">; -def _SLASH_GR : CLFlag<"GR">, HelpText<"Enable emission of RTTI data">; -def _SLASH_GR_ : CLFlag<"GR-">, HelpText<"Disable emission of RTTI data">; -def _SLASH_GF : CLIgnoredFlag<"GF">, HelpText<"Enable string pooling (default)">; +def _SLASH_GR : CLFlag<"GR">, HelpText<"Emit RTTI data (default)">; +def _SLASH_GR_ : CLFlag<"GR-">, HelpText<"Do not emit RTTI data">; +def _SLASH_GF : CLIgnoredFlag<"GF">, + HelpText<"Enable string pooling (default)">; def _SLASH_GF_ : CLFlag<"GF-">, HelpText<"Disable string pooling">, Alias; -def _SLASH_GS : CLFlag<"GS">, HelpText<"Enable buffer security check (default)">; +def _SLASH_GS : CLFlag<"GS">, + HelpText<"Enable buffer security check (default)">; def _SLASH_GS_ : CLFlag<"GS-">, HelpText<"Disable buffer security check">; def : CLFlag<"Gs">, HelpText<"Use stack probes (default)">, Alias, AliasArgs<["4096"]>; @@ -102,7 +104,7 @@ def _SLASH_Gw : CLFlag<"Gw">, HelpText<"Put each data item in its own section">, Alias; def _SLASH_Gw_ : CLFlag<"Gw-">, - HelpText<"Don't put each data item in its own section">, + HelpText<"Don't put each data item in its own section (default)">, Alias; def _SLASH_help : CLFlag<"help">, Alias, HelpText<"Display available options">; @@ -121,13 +123,13 @@ // FIXME: Not sure why we have -O0 here; MSVC doesn't support that. def : CLFlag<"O0">, Alias, HelpText<"Disable optimization">; def : CLFlag<"O1">, Alias<_SLASH_O>, AliasArgs<["1"]>, - HelpText<"Optimize for size (same as /Og /Os /Oy /Ob2 /GF /Gy)">; + HelpText<"Optimize for size (like /Og /Os /Oy /Ob2 /GF /Gy)">; def : CLFlag<"O2">, Alias<_SLASH_O>, AliasArgs<["2"]>, - HelpText<"Optimize for speed (same as /Og /Oi /Ot /Oy /Ob2 /GF /Gy)">; + HelpText<"Optimize for speed (like /Og /Oi /Ot /Oy /Ob2 /GF /Gy)">; def : CLFlag<"Ob0">, Alias<_SLASH_O>, AliasArgs<["b0"]>, HelpText<"Disable function inlining">; def : CLFlag<"Ob1">, Alias<_SLASH_O>, AliasArgs<["b1"]>, - HelpText<"Only inline functions which are (explicitly or implicitly) marked inline">; + HelpText<"Only inline functions explicitly or implicitly marked inline">; def : CLFlag<"Ob2">, Alias<_SLASH_O>, AliasArgs<["b2"]>,
