From ad1e7dd3bd6c1032a67d71b1cec94b5346f45777 Mon Sep 17 00:00:00 2001 From: Alp Toker Date: Sat, 28 Dec 2013 21:59:11 +0000 Subject: 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. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@198128 91177308-0d34-0410-b5e6-96231b3b80d8 --- tools/diag-build/diag-build.sh | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'tools/diag-build') diff --git a/tools/diag-build/diag-build.sh b/tools/diag-build/diag-build.sh index 4fef8fb2f9..018288dda9 100755 --- a/tools/diag-build/diag-build.sh +++ b/tools/diag-build/diag-build.sh @@ -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]' -- cgit v1.2.1