Page MenuHomePhabricator

Various minor tweaks to CLCompatOptions.td
ClosedPublic

Authored by thakis on Jul 10 2019, 9:03 AM.

Details

Reviewers
rnk
Summary
  • 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.

Diff Detail

Event Timeline

thakis created this revision.Jul 10 2019, 9:03 AM
rnk added inline comments.Jul 10 2019, 1:55 PM
clang/include/clang/Driver/CLCompatOptions.td
102

ditto

107

Standardize on uncontracted "Do not"?

250

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.

294

"Deprecated in favor of /EHsc"? or "(use /EHsc instead)"?

thakis marked 4 inline comments as done.

comments

clang/include/clang/Driver/CLCompatOptions.td
250

"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)

294

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.)

rnk accepted this revision.Jul 10 2019, 5:17 PM

lgtm

clang/include/clang/Driver/CLCompatOptions.td
294

👍

This revision is now accepted and ready to land.Jul 10 2019, 5:17 PM
hans added a comment.Jul 17 2019, 3:05 AM

Thanks for polishing the UX! :-)