X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=doc%2Fccanlint.1.txt;h=b2f1537a0c6c5e4e7b5059a3e2689b7acf78e1fa;hp=af3950c718cd5535c95be7bfd63fb06b34a3cb6c;hb=e846b1a93ecf096164ff2c4faaf4a89c24a0e76b;hpb=09b9554c30fccffd56cd9e0239415e5f7f597790 diff --git a/doc/ccanlint.1.txt b/doc/ccanlint.1.txt index af3950c7..b2f1537a 100644 --- a/doc/ccanlint.1.txt +++ b/doc/ccanlint.1.txt @@ -19,7 +19,7 @@ No encoder? No need to *ccanlint*. You programmer? Excited to *ccanlint*! CCAN module is small code of the song. *ccanlint* full CCAN testing tool. Each test spray bit of wisdom. Also score. Good score good. -Bad bad score. +Bad score bad. *ccanlint* expect the source code in this directory, or command line can be more than one. Exit 0 happy if all modules all tests happy. @@ -80,13 +80,17 @@ test, but happy: * // Test module foolish for me great! * info_documentation_exists FAIL * // Error for the file may be only - * tests_pass_valgrind_noleaks run-mytest.c:FAIL + * tests_pass_valgrind_noleaks test/run-mytest.c:FAIL --------------------------------------------------------------------- *info_exists*:: CCAN module must have '_info' file describing. No this score is 0. However, *ccanlint* question may help to write one. +*info_ported*:: + CCAN module '_info' can say 'ported' arg; if says '0' not ported, few tests + run. + *depends_exist*:: '_info' file CCAN other module without saying, must find. It is not score 0. @@ -175,11 +179,13 @@ test, but happy: bad example *ccanlint* says wow! *examples_run*:: - If the example program that comments like '// given foo outputs bar' - *ccanlint* will run the food program 'foo' in the command line and - standard input. Happy if 'bar' are out. You can do ' or " about - the production or determined. You can also 'output contains' more - relaxed controls. + If the example program that comments like '// [Given "foo"] outputs + "bar"' then *ccanlint* will run the program with 'foo' in the + command line and standard input. Happy if 'bar' are out and exit 0. + If quotes around 'bar' exact match needed; without quotes whitespace matches + any other space and trailing ignored. \n is also supported for + matching. You can also '"output contains"' to pass if the output + contains the string. *module_links*:: CCAN link to the program module simply no error. @@ -210,8 +216,8 @@ test, but happy: *tests_pass_valgrind*:: *valgrind* the tool of all 'run' and 'api' slow test. However, we found many errors! If *valgrind* test rest, '_info' have *ccanlint* section, - make "tests_pass_valgrind TESTNAME:FAIL". If required - valgrind additional option, "tests_pass_valgrind TESTNAME:--option". + make "tests_pass_valgrind test/TESTNAME:FAIL". If required + valgrind additional option, "tests_pass_valgrind test/TESTNAME:--option". *tests_pass_valgrind_noleaks*:: *valgrind* complain if the memory leak test. '_info' can also be disabled.