Add a small "usage:" comment at the top of not.cpp
authorSean Silva <chisophugis@gmail.com>
Wed, 26 Nov 2014 22:53:46 +0000 (22:53 +0000)
committerSean Silva <chisophugis@gmail.com>
Wed, 26 Nov 2014 22:53:46 +0000 (22:53 +0000)
Mostly pulled from Rafael's r185678 commit message.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@222855 91177308-0d34-0410-b5e6-96231b3b80d8

utils/not/not.cpp

index 2adeded51f0783bc63cce4d811e42732fbf6edd1..23062fb323d7fdef7f10591bfa83f82508a54376 100644 (file)
@@ -6,6 +6,11 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+// Usage:
+//   not cmd
+//     Will return true if cmd doesn't crash and returns false.
+//   not --crash cmd
+//     Will return true if cmd crashes (e.g. for testing crash reporting).
 
 #include "llvm/Support/Path.h"
 #include "llvm/Support/Program.h"