]> git.ozlabs.org Git - ccan/blobdiff - doc/ccanlint.1.txt
tools/ccanlint: make sure _info compiles.
[ccan] / doc / ccanlint.1.txt
index 4ba52493c0f494e5b3d088e298e64642bacd4fc1..b2f1537a0c6c5e4e7b5059a3e2689b7acf78e1fa 100644 (file)
@@ -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.
@@ -87,6 +87,10 @@ test, but happy:
   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.