[PATCH] D52999: [FileCheck] Annotate input dump (1/7)

[Paul Robinson via Phabricator via llvm-commits]

probinson added inline comments.


================
Comment at: llvm/utils/FileCheck/FileCheck.cpp:486
+    errs() << '\n';
+    DumpInputAnnotationExplanation(errs(), Req);
+    std::vector<InputAnnotation> Annotations;
----------------
jdenny wrote:
> probinson wrote:
> > jdenny wrote:
> > > probinson wrote:
> > > > The detailed description of the annotations becomes long enough that I think including it with the dumped input starts to get in the way.  Maybe have a `-dump-input=help` that will print the description and quit, or something along those lines.
> > > > The detailed description of the annotations becomes long enough that I think including it with the dumped input starts to get in the way. Maybe have a -dump-input=help that will print the description and quit, or something along those lines.
> > > 
> > > 
> > > If the input dump is short, I usually don't need the dump.  I usually need the dump when it's long, and then the description is relatively tiny and doesn't feel like it's in the way.  Moreover, I don't want to force users to remember how to obtain that description (FileCheck isn't even normally in my PATH, so that's another barrier), so I think it's more convenient just to print it with the dump.
> > > 
> > > However, you're the second person with your opinion, so I'm outvoted, and I'm fine with that.  Any objection to always dumping a reminder that -dump-input=help exists?
> > A reminder that -dump-input=help exists would be totally appropriate.
> > A reminder that -dump-input=help exists would be totally appropriate.
> 
> I'm assuming that -dump-input=fail might be used by bots, and I'm thinking about what happens when someone is reading without a terminal handy to run FileCheck -dump-input=help.  Should we assume such people will quickly become familiar enough with these annotations that they don't need the description, or should we offer something more?
> 
> Perhaps the description should also appear in rst/html documentation, and perhaps the reminder should be a pointer to that instead of -dump-input=help because the former is more universally accessible.
> 
> What do you think?
If a test failure is so involved that the annotations would be helpful, I think people would be running the test locally to try to debug it.  So, getting the help from the tool should be fine.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D52999/new/

https://reviews.llvm.org/D52999