openwhisk-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mrutkow...@apache.org
Subject [incubator-openwhisk-utilities] branch master updated: Update README.md
Date Wed, 17 May 2017 21:21:23 GMT
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  f72e310   Update README.md
f72e310 is described below

commit f72e3109624ef6d2cae5f75dbb48e38870157ab4
Author: Matt Rutkowski <mrutkows@us.ibm.com>
AuthorDate: Wed May 17 17:21:22 2017 -0400

    Update README.md
---
 scancode/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/scancode/README.md b/scancode/README.md
index 8b13789..0a65090 100644
--- a/scancode/README.md
+++ b/scancode/README.md
@@ -1 +1,46 @@
+scancode
+
+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
+
+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
+
+[Excludes]
+
+List of paths (inclusive of subdirectories) to exlude from code scanning.
+[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).
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@openwhisk.apache.org" <commits@openwhisk.apache.org>'].

Mime
View raw message