From 6e7e065d70fe5c9f0d28544340e3226d9f86e19f Mon Sep 17 00:00:00 2001 From: mpeterv Date: Thu, 4 Feb 2016 11:51:12 +0300 Subject: Update docs for inclusion patterns [ci skip] --- README.md | 11 ++++++----- src/bin/luacov | 4 ++-- src/luacov/defaults.lua | 4 ++-- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 923ecca..823d95b 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,14 @@ suite. To start the accounting from scratch, just delete the stats file. To generate a report, just run the `luacov` command-line script. It expects to find a file named `luacov.stats.out` in the current directory, and outputs a -file named `luacov.report.out`. The script take the following parameters; +file named `luacov.report.out`. The script takes the following parameters: - luacov [-c=configfile] [filename [ filename[ ...]]] + luacov [-c=configfile] [filename...] -For the `-c` option see below at [configuration](#configuration). The filenames (actually -patterns) indicate the files to include in the report, specifying them here -equals to adding them to the `include` list in the configuration file. +For the `-c` option see below at [configuration](#configuration). The filenames +(actually Lua patterns) indicate the files to include in the report, specifying them here +equals to adding them to the `include` list in the configuration file, with `.lua` +extension stripped. This is an example output of the report file: diff --git a/src/bin/luacov b/src/bin/luacov index c28a61b..60c477a 100755 --- a/src/bin/luacov +++ b/src/bin/luacov @@ -16,8 +16,8 @@ Usage: Launch this script to generate a report from collected stats. By default it reports on every Lua file encountered running your - script. To filter filenames, pass one or more patterns in the - command line, or use a config. + script. To filter filenames, pass one or more Lua patterns matching + files to be inclueded in the command line, or use a config. Options: -c filename, --config filename diff --git a/src/luacov/defaults.lua b/src/luacov/defaults.lua index 89ab063..50213b4 100644 --- a/src/luacov/defaults.lua +++ b/src/luacov/defaults.lua @@ -30,13 +30,13 @@ return { -- does not start with '@'. Default: false. codefromstrings = false, - --- Patterns for files to include when reporting. + --- Lua patterns for files to include when reporting. -- All will be included if nothing is listed. -- Do not include the '.lua' extension. Path separator is always '/'. -- Overruled by `exclude`. include = {}, - --- Patterns for files to exclude when reporting. + --- Lua patterns for files to exclude when reporting. -- Nothing will be excluded if nothing is listed. -- Do not include the '.lua' extension. Path separator is always '/'. -- Overrules `include`. -- cgit v1.2.1