From c8415e0849ec4b73c4c90a12f202fec5a3376c1c Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Wed, 17 Apr 2019 16:13:46 +0900 Subject: [PATCH] Add usage to README.rst and usage document This commit adds an example usage to README.rst and usage document for convenience. Change-Id: Id1d6e58eea5f6f70568a1716f19add4d531f4ab1 --- README.rst | 4 ++++ doc/source/user/index.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 3e5a304..72ee34c 100644 --- a/README.rst +++ b/README.rst @@ -51,6 +51,10 @@ the coverage2sql command to populate the database with data from your test coverage file. coverage2sql takes in a `.coverage file`_ through by passing it file paths as positional arguments to the script at this moment. +For example:: + + coverage2sql --config-file etc/coverage2sql.conf coverage2sql .coverage + .. _.coverage file: https://coverage.readthedocs.io/en/latest/cmd.html#data-file There are several options for running coverage2sql, they can be listed with:: diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 00f53a8..a5a397d 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -27,6 +27,10 @@ the coverage2sql command to populate the database with data from your test coverage file. coverage2sql takes in a `.coverage file`_ through by passing it file paths as positional arguments to the script at this moment. +For example:: + + coverage2sql --config-file etc/coverage2sql.conf coverage2sql .coverage + .. _.coverage file: https://coverage.readthedocs.io/en/latest/cmd.html#data-file There are several options for running coverage2sql, they can be listed with::