r198128 - Briefly document diag-build.sh

[Alp Toker]

Author: alp
Date: Sat Dec 28 15:59:11 2013
New Revision: 198128

URL: http://llvm.org/viewvc/llvm-project?rev=198128&view=rev
Log:
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.

Modified:
    cfe/trunk/tools/diag-build/diag-build.sh

Modified: cfe/trunk/tools/diag-build/diag-build.sh
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/tools/diag-build/diag-build.sh?rev=198128&r1=198127&r2=198128&view=diff
==============================================================================
--- cfe/trunk/tools/diag-build/diag-build.sh (original)
+++ cfe/trunk/tools/diag-build/diag-build.sh Sat Dec 28 15:59:11 2013
@@ -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]'