Briefly document diag-build.sh

It may be a quick and dirty script but it's still useful to have some
indication as to its purpose.

Text taken straight from Jordan's r158682 commit message.

llvm-svn: 198128
This commit is contained in:
Alp Toker 2013-12-28 21:59:11 +00:00
parent a724cff01b
commit 8214bf5eef
1 changed files with 9 additions and 0 deletions

View File

@ -1,5 +1,14 @@
#!/bin/bash
# diag-build: a tool showing enabled warnings in a project.
#
# diag-build acts as a wrapper for 'diagtool show-enabled', in the same way
# that scan-build acts as a wrapper for the static analyzer. The common case is
# simple: use 'diag-build make' or 'diag-build xcodebuild' to list the warnings
# enabled for the first compilation command we see. Other build systems require
# you to manually specify "dry-run" and "use $CC and $CXX"; if there is a build
# system you are interested in, please add it to the switch statement.
print_usage () {
echo 'Usage: diag-build.sh [-v] xcodebuild [flags]'
echo ' diag-build.sh [-v] make [flags]'