On Wed, 1 Apr 2020 at 06:07, Markus Armbruster <arm...@redhat.com> wrote:
> Generic instructions for using .cocci scripts should go into README. > Enough to get you started if you know nothing about Coccinelle. > > Options that should always be used with a certain script should be > documented in that script. > > Options that only affect work-flow, not the patch, I'd rather keep out > of the script. If there are any we feel we should mention, do that in > README. Example: --no-show-diff. But then as a coccinelle script author I need to know which of the options I needed are standard, which are for-this-script-only, and which are just 'workflow'. And as a reader I *still* need to go and look through the README and look at this script and then try to reconstitute what command line might have been used. That's more work for the author *and* more work for the reader than just "put the command line you used into the script as a comment" -- so who's it benefiting? thanks -- PMM
