From 8214bf5eef9c3c58fcb7a14e42d65e40e8405b7d Mon Sep 17 00:00:00 2001
From: Alp Toker <alp@nuanti.com>
Date: Sat, 28 Dec 2013 21:59:11 +0000
Subject: [PATCH] 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
---
clang/tools/diag-build/diag-build.sh | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/clang/tools/diag-build/diag-build.sh b/clang/tools/diag-build/diag-build.sh
index 4fef8fb2f961..018288dda956 100755
--- a/clang/tools/diag-build/diag-build.sh
+++ b/clang/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]'