From 3317c70b07d43f3038c0cef9316f45d20803983f Mon Sep 17 00:00:00 2001
From: Marco Castelluccio <mcastelluccio@mozilla.com>
Date: Fri, 5 Oct 2018 16:28:27 +0200
Subject: [PATCH] Misc improvements to documentation

---
 README.md | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 2a3e5e4..6cd88da 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,24 @@ This is a project initiated by Mozilla to gather code coverage results on Firefo
 2. Run grcov:
 
 ```
-Usage: grcov DIRECTORY[...] [-t OUTPUT_TYPE] [-s SOURCE_ROOT] [--token COVERALLS_REPO_TOKEN]
+Usage: grcov DIRECTORY_OR_ZIP_FILE[...] [-t OUTPUT_TYPE] [-s SOURCE_ROOT] [-p PREFIX_PATH] [--token COVERALLS_REPO_TOKEN] [--commit-sha COVERALLS_COMMIT_SHA] [--keep-global-includes] [--ignore-not-existing] [--ignore-dir DIRECTORY] [--llvm] [--path-mapping PATH_MAPPING_FILE] [--branch] [--filter] [--add-prefix ADDED_PREFIX_PATH]
 You can specify one or more directories, separated by a space.
 OUTPUT_TYPE can be one of:
  - (DEFAULT) ade for the ActiveData-ETL specific format;
  - lcov for the lcov INFO format;
  - coveralls for the Coveralls specific format.
-SOURCE_ROOT is the root directory of the source files, required for the 'coveralls' format.
-REPO_TOKEN is the repository token from Coveralls, required for the 'coveralls' format.
+ - coveralls+ for the Coveralls specific format with function information.
+SOURCE_ROOT is the root directory of the source files.
+PREFIX_PATH is a prefix to remove from the paths (e.g. if grcov is run on a different machine than the one that generated the code coverage information).
+ADDED_PREFIX_PATH is a prefix to add to the paths.
+COVERALLS_REPO_TOKEN is the repository token from Coveralls, required for the 'coveralls' and 'coveralls+' format.
+COVERALLS_COMMIT_SHA is the SHA of the commit used to generate the code coverage data.
+By default global includes are ignored. Use --keep-global-includes to keep them.
+By default source files that can't be found on the disk are not ignored. Use --ignore-not-existing to ignore them.
+The --llvm option must be used when the code coverage information is coming from a llvm build.
+The --ignore-dir option can be used to ignore directories.
+The --branch option enables parsing branch coverage information.
+The --filter option allows filtering out covered/uncovered files. Use 'covered' to only return covered files, 'uncovered' to only return uncovered files.
 ```
 
 Let's see a few examples, assuming the source directory is `~/Documents/mozilla-central` and the build directory is `~/Documents/mozilla-central/build`.
@@ -47,18 +57,17 @@ grcov ~/Documents/FD/mozilla-central/build -t coveralls -s ~/Documents/FD/mozill
 
 ```
 cargo build
-# By default, the binary is generated in ./target/debug/grcov
 ```
 
-To test the binary:
+To run tests:
 ```
 cargo test
 ```
 
 ## Minimum requirements
 
-- GCC 4.9 or higher is required (if parsing coverage artifacts generated by GCC)
+- GCC 4.9 or higher is required (if parsing coverage artifacts generated by GCC).
 
-## License
+## License
 
-Published under the MPL 2.0 license
+Published under the MPL 2.0 license.