This is an automated email from the ASF dual-hosted git repository.
mrutkowski pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-openwhisk-utilities.git
The following commit(s) were added to refs/heads/master by this push:
new 18e968a Update README.md
18e968a is described below
commit 18e968ab2e1cd3711eae2fac4876da09166d92d1
Author: Matt Rutkowski <[email protected]>
AuthorDate: Wed May 17 17:22:13 2017 -0400
Update README.md
---
scancode/README.md | 77 +++++++++++++++++++++++++++++++-----------------------
1 file changed, 45 insertions(+), 32 deletions(-)
diff --git a/scancode/README.md b/scancode/README.md
index 0a65090..42f3236 100644
--- a/scancode/README.md
+++ b/scancode/README.md
@@ -1,46 +1,59 @@
-scancode
+# scancode
+_Simple configurable code scanner in Python._
-Simple configurable code scanner in Python.
-Usage
-scanCode.py [-h] [-v] [--config CONFIG] root_directory
-
-Scans all source code under specified directory for project compliance using
provided configuration.
-positional arguments:
-
- root_directory : starting directory for the scan
-
-optional arguments:
-
- -h, --help : show this help message and exit
- -v, --verbose : enable verbose output
- --config CONFIG : provide custom configuration file
+## Usage
-Configuration file format
-Supported sections
-[Licenses]
-
-List of filenames containing the text of valid license (headers). These files
SHOULD be in the same directory path where scanCode.py resides.
-[Includes]
-
-Filters (path/filename) with wildcards and associated scan checks that are to
be run against them. The checks are actual valid function names found in
scanCode.py.
+```
+scanCode.py [-h] [-v] [--config CONFIG] root_directory
+```
+
+Scans all source code under specified directory for project compliance using
+provided configuration.
+
+### positional arguments:
+ * root_directory : starting directory for the scan
+
+### optional arguments:
+ * -h, --help : show this help message and exit
+ * -v, --verbose : enable verbose output
+ * --config CONFIG : provide custom configuration file
+
+ # Configuration file format
+
+ ## Supported sections
+
+ ### [Licenses]
+
+List of filenames containing the text of valid license (headers).
+These files SHOULD be in the same directory path where scanCode.py
+resides.
+
+### [Includes]
+
+Filters (path/filename) with wildcards and associated scan checks
+that are to be run against them. The checks are actual valid
+function names found in scanCode.py.
These include:
+- has_block_license
+- no_tabs
+- no_trailing_spaces
+- eol_at_eof
- has_block_license
- no_tabs
- no_trailing_spaces
- eol_at_eof
-
-[Excludes]
+### [Excludes]
List of paths (inclusive of subdirectories) to exlude from code scanning.
-[Options]
+
+### [Options]
List of additional key-value pair format options.
Currently, the following options are supported:
- LICENSE_SLACK_LENGTH (apples to check 'has_block_license')
- Not all code files allow licenses to appear starting at the first
character of the file. This option tells the scan to allow licenses to appear
starting within first 'x' characters of each code file (as provided by this
option's value).
+- LICENSE_SLACK_LENGTH (apples to check 'has_block_license')
+ - Not all code files allow licenses to appear starting at the first character
+ of the file. This option tells the scan to allow licenses to appear
starting
+ within first 'x' characters of each code file (as provided by this option's
+ value).
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
