From 839f8e4fe2dcf490a0972d7761f95e5a6b287faf Mon Sep 17 00:00:00 2001 From: "Joel E. Denny" Date: Thu, 9 Jul 2020 17:31:31 -0400 Subject: [PATCH] [FileCheck] Improve -dump-input documentation Document the default of `fail` in `-help`. Extend `-dump-input=help` to help users find related command-line options, but let `-help` provide their full documentation. Reviewed By: probinson Differential Revision: https://reviews.llvm.org/D83091 --- llvm/test/FileCheck/dump-input-enable.txt | 2 +- llvm/utils/FileCheck/FileCheck.cpp | 25 ++++++++++++++----------- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/llvm/test/FileCheck/dump-input-enable.txt b/llvm/test/FileCheck/dump-input-enable.txt index 6f1f8e12320..b0aacfb2fed 100644 --- a/llvm/test/FileCheck/dump-input-enable.txt +++ b/llvm/test/FileCheck/dump-input-enable.txt @@ -224,7 +224,7 @@ BADVAL: {{F|f}}ile{{C|c}}heck{{.*}}: for the --dump-input option: Cannot find op ; HELP-NOT: {{.}} ; HELP: The following description was requested by -dump-input=help -; HELP: try{{.*}}-color +; HELP: - colors {{.*}} ; HELP-NOT: {{.}} ; Trace is sometimes suppressed. diff --git a/llvm/utils/FileCheck/FileCheck.cpp b/llvm/utils/FileCheck/FileCheck.cpp index e0037b596cd..659491c8963 100644 --- a/llvm/utils/FileCheck/FileCheck.cpp +++ b/llvm/utils/FileCheck/FileCheck.cpp @@ -121,10 +121,9 @@ static cl::list DumpInputs( cl::desc("Dump input to stderr, adding annotations representing\n" "currently enabled diagnostics. When there are multiple\n" "occurrences of this option, the that appears earliest\n" - "in the list below has precedence.\n"), + "in the list below has precedence. The default is 'fail'.\n"), cl::value_desc("mode"), - cl::values(clEnumValN(DumpInputHelp, "help", - "Explain dump format and quit"), + cl::values(clEnumValN(DumpInputHelp, "help", "Explain input dump and quit"), clEnumValN(DumpInputAlways, "always", "Always dump input"), clEnumValN(DumpInputFail, "fail", "Dump input on failure"), clEnumValN(DumpInputNever, "never", "Never dump input"))); @@ -180,8 +179,15 @@ static MarkerStyle GetMarker(FileCheckDiag::MatchType MatchTy) { static void DumpInputAnnotationHelp(raw_ostream &OS) { OS << "The following description was requested by -dump-input=help to\n" - << "explain the input annotations printed by -dump-input=always and\n" - << "-dump-input=fail:\n\n"; + << "explain the input dump printed by FileCheck.\n" + << "\n" + << "Related command-line options:\n" + << " - -dump-input= enables or disables the input dump\n" + << " - -v and -vv add more annotations\n" + << " - -color forces colors to be enabled both in the dump and below\n" + << " - -help documents the above options in more detail\n" + << "\n" + << "Input dump annotation format:\n"; // Labels for input lines. OS << " - "; @@ -233,8 +239,7 @@ static void DumpInputAnnotationHelp(raw_ostream &OS) { WithColor(OS, raw_ostream::CYAN, true, false) << "discarded match"; OS << ", "; WithColor(OS, raw_ostream::CYAN, true, true) << "unmatched input"; - OS << "\n\n" - << "If you are not seeing color above or in input dumps, try: -color\n"; + OS << "\n"; } /// An annotation for a single input line. @@ -675,12 +680,10 @@ int main(int argc, char **argv) { if (DumpInput == DumpInputAlways || (ExitCode == 1 && DumpInput == DumpInputFail)) { errs() << "\n" - << "Input file: " - << InputFilename - << "\n" + << "Input file: " << InputFilename << "\n" << "Check file: " << CheckFilename << "\n" << "\n" - << "-dump-input=help describes the format of the following dump.\n" + << "-dump-input=help explains the following input dump.\n" << "\n"; std::vector Annotations; unsigned LabelWidth; -- 2.11.0