From ceff80d6cfc41ce95bdcfc53d16967158e9da115 Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:28:12 +0300 Subject: [PATCH 1/6] Move sources of uncov docs into a subdirectory --- Makefile | 4 ++-- docs/{ => uncov}/01-name.md | 0 docs/{ => uncov}/02-synopsis.md | 0 docs/{ => uncov}/03-options.md | 0 docs/{ => uncov}/04-description.md | 0 docs/{ => uncov}/05-subcommands.md | 0 docs/{ => uncov}/06-subcommand-list.md | 0 docs/{ => uncov}/07-files.md | 0 8 files changed, 2 insertions(+), 2 deletions(-) rename docs/{ => uncov}/01-name.md (100%) rename docs/{ => uncov}/02-synopsis.md (100%) rename docs/{ => uncov}/03-options.md (100%) rename docs/{ => uncov}/04-description.md (100%) rename docs/{ => uncov}/05-subcommands.md (100%) rename docs/{ => uncov}/06-subcommand-list.md (100%) rename docs/{ => uncov}/07-files.md (100%) diff --git a/Makefile b/Makefile index 72b1ab2..7bae909 100644 --- a/Makefile +++ b/Makefile @@ -124,14 +124,14 @@ self-coverage: coverage man: docs/uncov.1 # the next target doesn't depend on $(wildcard docs/*.md) to make pandoc # optional -docs/uncov.1: force | $(out_dir)/docs +docs/uncov.1: force | $(out_dir)/docs/uncov pandoc -V title=uncov \ -V section=1 \ -V app=uncov \ -V footer="uncov v0.1" \ -V date="$$(date +'%B %d, %Y')" \ -V author='xaizek ' \ - -s -o $@ $(sort $(wildcard docs/*.md)) + -s -o $@ $(sort $(wildcard docs/uncov/*.md)) doxygen: doxygen doxygen/config diff --git a/docs/01-name.md b/docs/uncov/01-name.md similarity index 100% rename from docs/01-name.md rename to docs/uncov/01-name.md diff --git a/docs/02-synopsis.md b/docs/uncov/02-synopsis.md similarity index 100% rename from docs/02-synopsis.md rename to docs/uncov/02-synopsis.md diff --git a/docs/03-options.md b/docs/uncov/03-options.md similarity index 100% rename from docs/03-options.md rename to docs/uncov/03-options.md diff --git a/docs/04-description.md b/docs/uncov/04-description.md similarity index 100% rename from docs/04-description.md rename to docs/uncov/04-description.md diff --git a/docs/05-subcommands.md b/docs/uncov/05-subcommands.md similarity index 100% rename from docs/05-subcommands.md rename to docs/uncov/05-subcommands.md diff --git a/docs/06-subcommand-list.md b/docs/uncov/06-subcommand-list.md similarity index 100% rename from docs/06-subcommand-list.md rename to docs/uncov/06-subcommand-list.md diff --git a/docs/07-files.md b/docs/uncov/07-files.md similarity index 100% rename from docs/07-files.md rename to docs/uncov/07-files.md From 6001b7c7b9867539c9153f41f824fcd2a0d1a72c Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:47:35 +0300 Subject: [PATCH 2/6] Make args in synopsis bold in the manual page --- docs/uncov.1 | 9 +++++---- docs/uncov/02-synopsis.md | 6 +++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/uncov.1 b/docs/uncov.1 index fd0f61c..8580cbf 100644 --- a/docs/uncov.1 +++ b/docs/uncov.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 1.17.0.3 .\" -.TH "uncov" "1" "September 15, 2017" "uncov v0.1" "" +.TH "uncov" "1" "September 18, 2017" "uncov v0.1" "" .hy .SH NAME .PP @@ -8,11 +8,12 @@ uncov is a software development tool that collect and processes coverage reports. .SH SYNOPSIS .PP -\f[B]uncov\f[] \-h|\-\-help +\f[B]uncov\f[] \f[B]\-h|\-\-help\f[] .PP -\f[B]uncov\f[] \-v|\-\-version +\f[B]uncov\f[] \f[B]\-v|\-\-version\f[] .PP -\f[B]uncov\f[] [] [...] +\f[B]uncov\f[] \f[B][]\f[] \f[B]\f[] +\f[B][...]\f[] .SH OPTIONS .SS \f[B]\-\-help, \-h\f[] .PP diff --git a/docs/uncov/02-synopsis.md b/docs/uncov/02-synopsis.md index 44f689f..8b512bb 100644 --- a/docs/uncov/02-synopsis.md +++ b/docs/uncov/02-synopsis.md @@ -1,8 +1,8 @@ SYNOPSIS ======== -**uncov** -h|--help +**uncov** **-h|--help** -**uncov** -v|--version +**uncov** **-v|--version** -**uncov** [\] \ [\...] +**uncov** **[\]** **\** **[\...]** From 38eb44ac85814b492616f3f31803e8fa7b4ff7e6 Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:48:41 +0300 Subject: [PATCH 3/6] Fix a typo in uncov-gcov's usage --- uncov-gcov | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/uncov-gcov b/uncov-gcov index 14f60e3..f17223c 100755 --- a/uncov-gcov +++ b/uncov-gcov @@ -97,7 +97,7 @@ def create_args(params): help='Follow symlinks (default off)') parser.add_argument('-c', '--capture-worktree', action='store_true', default=False, - help='Make an dangling commit if working directory is ' + help='Make a dangling commit if working directory is ' 'dirty') parser.add_argument('--ref-name', default=None, metavar='REF', help='force custom ref name') From a11b4035df1e4535af389e59ac978e5da08d74e9 Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:54:09 +0300 Subject: [PATCH 4/6] Add manual pages for uncov-gcov and uncov-web --- INSTALL.md | 2 +- Makefile | 27 +++++++- TODO.md | 6 -- docs/uncov-gcov.1 | 112 +++++++++++++++++++++++++++++++ docs/uncov-gcov/01-name.md | 5 ++ docs/uncov-gcov/02-synopsis.md | 8 +++ docs/uncov-gcov/03-options.md | 101 ++++++++++++++++++++++++++++ docs/uncov-gcov/04-usage.md | 26 +++++++ docs/uncov-gcov/05-see-also.md | 4 ++ docs/uncov-web.1 | 63 +++++++++++++++++ docs/uncov-web/01-name.md | 5 ++ docs/uncov-web/02-synopsis.md | 8 +++ docs/uncov-web/03-options.md | 32 +++++++++ docs/uncov-web/04-description.md | 16 +++++ docs/uncov-web/05-files.md | 4 ++ docs/uncov-web/06-see-also.md | 4 ++ docs/uncov.1 | 3 + docs/uncov/08-see-also.md | 4 ++ 18 files changed, 420 insertions(+), 10 deletions(-) create mode 100644 docs/uncov-gcov.1 create mode 100644 docs/uncov-gcov/01-name.md create mode 100644 docs/uncov-gcov/02-synopsis.md create mode 100644 docs/uncov-gcov/03-options.md create mode 100644 docs/uncov-gcov/04-usage.md create mode 100644 docs/uncov-gcov/05-see-also.md create mode 100644 docs/uncov-web.1 create mode 100644 docs/uncov-web/01-name.md create mode 100644 docs/uncov-web/02-synopsis.md create mode 100644 docs/uncov-web/03-options.md create mode 100644 docs/uncov-web/04-description.md create mode 100644 docs/uncov-web/05-files.md create mode 100644 docs/uncov-web/06-see-also.md create mode 100644 docs/uncov/08-see-also.md diff --git a/INSTALL.md b/INSTALL.md index 54a02de..fe846eb 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -34,7 +34,7 @@ Builds debug version with undefined and address sanitizers enabled in **`man`** -Rebuilds manual page in `/docs/uncov.1`, requires `pandoc`. +Rebuilds manual pages in `/docs/`, requires `pandoc`. **`doxygen`** diff --git a/Makefile b/Makefile index 7bae909..97f9a8b 100644 --- a/Makefile +++ b/Makefile @@ -121,8 +121,8 @@ self-coverage: UNCOV_PREFIX := $(out_dir)/ self-coverage: GCOV_PREFIX := ./ self-coverage: coverage -man: docs/uncov.1 -# the next target doesn't depend on $(wildcard docs/*.md) to make pandoc +man: docs/uncov.1 docs/uncov-gcov.1 docs/uncov-web.1 +# the following targets don't depend on $(wildcard docs/*/*.md) to make pandoc # optional docs/uncov.1: force | $(out_dir)/docs/uncov pandoc -V title=uncov \ @@ -132,6 +132,22 @@ docs/uncov.1: force | $(out_dir)/docs/uncov -V date="$$(date +'%B %d, %Y')" \ -V author='xaizek ' \ -s -o $@ $(sort $(wildcard docs/uncov/*.md)) +docs/uncov-gcov.1: force | $(out_dir)/docs/uncov-gcov + pandoc -V title=uncov-gcov \ + -V section=1 \ + -V app=uncov-gcov \ + -V footer="uncov v0.1" \ + -V date="$$(date +'%B %d, %Y')" \ + -V author='xaizek ' \ + -s -o $@ $(sort $(wildcard docs/uncov-gcov/*.md)) +docs/uncov-web.1: force | $(out_dir)/docs/uncov-web + pandoc -V title=uncov-web \ + -V section=1 \ + -V app=uncov-web \ + -V footer="uncov v0.1" \ + -V date="$$(date +'%B %d, %Y')" \ + -V author='xaizek ' \ + -s -o $@ $(sort $(wildcard docs/uncov-web/*.md)) doxygen: doxygen doxygen/config @@ -166,11 +182,16 @@ install: release $(INSTALL) -t $(DESTDIR)/usr/bin/ $(bin) $(webbin) uncov-gcov $(INSTALL) -t $(DESTDIR)/usr/share/uncov/srchilight/ data/srchilight/* $(INSTALL) -m 644 docs/uncov.1 $(DESTDIR)/usr/share/man/man1/uncov.1 + $(INSTALL) -m 644 docs/uncov-gcov.1 \ + $(DESTDIR)/usr/share/man/man1/uncov-gcov.1 + $(INSTALL) -m 644 docs/uncov-web.1 $(DESTDIR)/usr/share/man/man1/uncov-web.1 uninstall: $(RM) $(DESTDIR)/usr/bin/$(basename $(bin)) \ $(DESTDIR)/usr/bin/$(basename $(webbin)) \ - $(DESTDIR)/usr/bin/uncov-gcov $(DESTDIR)/usr/share/man/man1/uncov.1 + $(DESTDIR)/usr/bin/uncov-gcov $(DESTDIR)/usr/share/man/man1/uncov.1 \ + $(DESTDIR)/usr/share/man/man1/uncov-gcov.1 \ + $(DESTDIR)/usr/share/man/man1/uncov-web.1 $(RM) -r $(DESTDIR)/usr/share/uncov/ # work around parenthesis warning in tests somehow caused by ccache diff --git a/TODO.md b/TODO.md index 8319349..571bdb5 100644 --- a/TODO.md +++ b/TODO.md @@ -74,12 +74,6 @@ maybe even when branch ref matches build commit. Maybe should also indicate "temporary" commits somehow. -## Write manual pages for uncov-gcov and uncov-web. ## - -| ID | Status | Type | -|------|-----------|--------| -| LSY | planned | task | - ## Source-highlight hangs if passed in std::istream is at EOF? ## | ID | Status | Type | diff --git a/docs/uncov-gcov.1 b/docs/uncov-gcov.1 new file mode 100644 index 0000000..d185449 --- /dev/null +++ b/docs/uncov-gcov.1 @@ -0,0 +1,112 @@ +.\" Automatically generated by Pandoc 1.17.0.3 +.\" +.TH "uncov-gcov" "1" "September 18, 2017" "uncov v0.1" "" +.hy +.SH NAME +.PP +uncov\-gcov is coverage information collector for C and C++ languages to +be used with \f[B]uncov(1)\f[]. +.SH SYNOPSIS +.PP +\f[B]uncov\-gcov\f[] \f[B]\-h|\-\-help\f[] +.PP +\f[B]uncov\-gcov\f[] \f[B]\-v|\-\-version\f[] +.PP +\f[B]uncov\-gcov\f[] \f[B][...]\f[] +.SH OPTIONS +.SS \f[B]\-\-help, \-h\f[] +.PP +Displays short usage help. +.SS \f[B]\-\-version, \-v\f[] +.PP +Displays version information. +.SS \f[B]\-\-verbose\f[] +.PP +Print verbose messages. +.SS \f[B]\-\-dryrun\f[] +.PP +Run the script without printing report. +.SS \f[B]\-\-gcov\f[] [=gcov] +.PP +Set the location of gcov. +.SS \f[B]\-\-gcov\-options\f[] [=""] +.PP +Set the options given to gcov. +.SS \f[B]\-r\f[], \f[B]\-\-root\f[] [=.] +.PP +Set the root directory. +.SS \f[B]\-b\f[], \f[B]\-\-build\-root\f[] [={discovered}] +.PP +Set the directory from which gcov will be called; by default gcov is run +in the directory of the .o files; however the paths of the sources are +often relative to the directory from which the compiler was run and +these relative paths are saved in the .o file; when this happens, gcov +needs to run in the same directory as the compiler in order to find the +source files. +.SS \f[B]\-\-collect\-root\f[] [={value of \-\-root}] +.PP +Directory to look gcov files in. +.SS \f[B]\-e\f[], \f[B]\-\-exclude\f[] [=""] +.PP +Set exclude file or directory. +.SS \f[B]\-i\f[], \f[B]\-\-include\f[] [=""] +.PP +Set include file or directory. +.SS \f[B]\-E\f[], \f[B]\-\-exclude\-pattern\f[] [=""] +.PP +Set exclude file/directory pattern. +.SS \f[B]\-x\f[], \f[B]\-\-extension\f[] +[=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm] +.PP +Set extension of files to process. +.SS \f[B]\-n\f[], \f[B]\-\-no\-gcov\f[] +.PP +Do not run gcov. +.SS \f[B]\-\-encodings\f[] [=utf\-8,latin\-1] +.PP +Source encodings to try in order of preference. +.SS \f[B]\-\-dump\f[] +.PP +Dump JSON payload to a file. +.SS \f[B]\-\-follow\-symlinks\f[] +.PP +Follow symlinks. +.SS \f[B]\-c\f[], \f[B]\-\-capture\-worktree\f[] +.PP +Make a dangling commit if working directory is dirty. +.SS \f[B]\-\-ref\-name\f[] [={discovered}] +.PP +Force custom ref name. +.SH USAGE +.PP +uncov\-gcov can be used to generate coverage, but it seems to not play +well with out\-of\-tree builds (some coverage is missing, this issue is +inherited from its origin), so the recommended way of recording coverage +information is as follows: +.IP +.nf +\f[C] +#\ reset\ coverage\ counters\ from\ previous\ runs +find\ .\ \-name\ \[aq]*.gcda\[aq]\ \-delete + +#\ run\ tests\ here\ with\ something\ like\ `make\ check` + +#\ generage\ coverage\ for\ every\ object\ file\ found\ (change\ "."\ to\ build\ root) +find\ .\ \-name\ \[aq]*.o\[aq]\ \-exec\ gcov\ \-p\ {}\ + + +#\ generage\ and\ combine\ coverage\ reports\ (\-\-capture\-worktree\ automatically +#\ makes\ stray\ commit\ if\ repository\ is\ dirty) +uncov\-gcov\ \-\-root\ .\ \-\-no\-gcov\ \-\-capture\-worktree\ \-\-exclude\ tests\ |\ uncov\ new + +#\ remove\ coverage\ reports +find\ .\ \-name\ \[aq]*.gcov\[aq]\ \-delete +\f[] +.fi +.PP +These commands can be put in a separate script or embedded directly into +build system. +.SH SEE ALSO +.PP +\f[B]uncov\f[](1), \f[B]uncov\-web\f[](1) +.SH AUTHORS +xaizek . diff --git a/docs/uncov-gcov/01-name.md b/docs/uncov-gcov/01-name.md new file mode 100644 index 0000000..262c88c --- /dev/null +++ b/docs/uncov-gcov/01-name.md @@ -0,0 +1,5 @@ +NAME +==== + +uncov-gcov is coverage information collector for C and C++ languages to be used +with **uncov(1)**. diff --git a/docs/uncov-gcov/02-synopsis.md b/docs/uncov-gcov/02-synopsis.md new file mode 100644 index 0000000..55f999e --- /dev/null +++ b/docs/uncov-gcov/02-synopsis.md @@ -0,0 +1,8 @@ +SYNOPSIS +======== + +**uncov-gcov** **-h|--help** + +**uncov-gcov** **-v|--version** + +**uncov-gcov** **[\...]** diff --git a/docs/uncov-gcov/03-options.md b/docs/uncov-gcov/03-options.md new file mode 100644 index 0000000..218b410 --- /dev/null +++ b/docs/uncov-gcov/03-options.md @@ -0,0 +1,101 @@ +OPTIONS +======= + +**--help, -h** +-------------- + +Displays short usage help. + +**--version, -v** +----------------- + +Displays version information. + +**--verbose** +------------- + +Print verbose messages. + +**--dryrun** +------------ + +Run the script without printing report. + +**--gcov** [=gcov] +------------------ + +Set the location of gcov. + +**--gcov-options** [=""] +------------------------ + +Set the options given to gcov. + +**-r**, **--root** [=.] +----------------------- + +Set the root directory. + +**-b**, **--build-root** [={discovered}] +---------------------------------------- + +Set the directory from which gcov will be called; by default gcov is run in the +directory of the .o files; however the paths of the sources are often relative +to the directory from which the compiler was run and these relative paths are +saved in the .o file; when this happens, gcov needs to run in the same directory +as the compiler in order to find the source files. + +**--collect-root** [={value of --root}] +--------------------------------------- + +Directory to look gcov files in. + +**-e**, **--exclude** [=""] +--------------------------- + +Set exclude file or directory. + +**-i**, **--include** [=""] +--------------------------- + +Set include file or directory. + +**-E**, **--exclude-pattern** [=""] +----------------------------------- + +Set exclude file/directory pattern. + +**-x**, **--extension** [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm] +------------------------------------------------------------------- + +Set extension of files to process. + +**-n**, **--no-gcov** +--------------------- + +Do not run gcov. + +**--encodings** [=utf-8,latin-1] +-------------------------------- + +Source encodings to try in order of preference. + +**--dump** \ +------------------- + +Dump JSON payload to a file. + +**--follow-symlinks** +--------------------- + +Follow symlinks. + +**-c**, **--capture-worktree** +------------------------------ + +Make a dangling commit if working directory is dirty. + +**--ref-name** [={discovered}] +------------------------------ + +Force custom ref name. diff --git a/docs/uncov-gcov/04-usage.md b/docs/uncov-gcov/04-usage.md new file mode 100644 index 0000000..0689efb --- /dev/null +++ b/docs/uncov-gcov/04-usage.md @@ -0,0 +1,26 @@ +USAGE +===== + +uncov-gcov can be used to generate coverage, but it seems to not play well with +out-of-tree builds (some coverage is missing, this issue is inherited from its +origin), so the recommended way of recording coverage information is as follows: + +``` +# reset coverage counters from previous runs +find . -name '*.gcda' -delete + +# run tests here with something like `make check` + +# generage coverage for every object file found (change "." to build root) +find . -name '*.o' -exec gcov -p {} + + +# generage and combine coverage reports (--capture-worktree automatically +# makes stray commit if repository is dirty) +uncov-gcov --root . --no-gcov --capture-worktree --exclude tests | uncov new + +# remove coverage reports +find . -name '*.gcov' -delete +``` + +These commands can be put in a separate script or embedded directly into build +system. diff --git a/docs/uncov-gcov/05-see-also.md b/docs/uncov-gcov/05-see-also.md new file mode 100644 index 0000000..9f57646 --- /dev/null +++ b/docs/uncov-gcov/05-see-also.md @@ -0,0 +1,4 @@ +SEE ALSO +======== + +**uncov**(1), **uncov-web**(1) diff --git a/docs/uncov-web.1 b/docs/uncov-web.1 new file mode 100644 index 0000000..cc60688 --- /dev/null +++ b/docs/uncov-web.1 @@ -0,0 +1,63 @@ +.\" Automatically generated by Pandoc 1.17.0.3 +.\" +.TH "uncov-web" "1" "September 18, 2017" "uncov v0.1" "" +.hy +.SH NAME +.PP +uncov\-web is a HTTP\-server that provides Web\-UI for browsing coverage +information collected by \f[B]uncov(1)\f[]. +.SH SYNOPSIS +.PP +\f[B]uncov\-web\f[] \f[B]\-h|\-\-help\f[] +.PP +\f[B]uncov\-web\f[] \f[B]\-v|\-\-version\f[] +.PP +\f[B]uncov\-web\f[] \f[B]\-\-vhost\f[] \f[B]\-\-ip\f[] +[=0.0.0.0] \f[B]\-\-repo\f[] [=.] \f[B]\-\-port\f[] [=8000] +.SH OPTIONS +.SS \f[B]\-\-help, \-h\f[] +.PP +Displays short usage help. +.SS \f[B]\-\-version, \-v\f[] +.PP +Displays version information. +.SS \f[B]\-\-vhost\f[] +.PP +Sets virtual host name. +This option is mandatory. +.SS \f[B]\-\-ip\f[] [=0.0.0.0] +.PP +IP address to bind to. +The default is to bind to all interfaces. +.SS \f[B]\-\-repo\f[] [=.] +.PP +Path to repository. +.SS \f[B]\-\-port\f[] [=8000] +.PP +Post to listen on. +.SH DESCRIPTION +.PP +Once started provides HTTP\-server to view coverage reports. +Does not daemonize itself. +.SS Notations +.PP +For the sake of brevity interface uses several intuitive abbreviations: +.IP \[bu] 2 +Cov \- coverage; +.IP \[bu] 2 +Ref \- reference (of VCS); +.IP \[bu] 2 +C \- covered; +.IP \[bu] 2 +M \- missed; +.IP \[bu] 2 +R \- relevant. +.SH FILES +.PP +\f[B]/uncov.sqlite\f[] \-\- storage of coverage +data. +.SH SEE ALSO +.PP +\f[B]uncov(1)\f[], \f[B]uncov\-gcov\f[](1) +.SH AUTHORS +xaizek . diff --git a/docs/uncov-web/01-name.md b/docs/uncov-web/01-name.md new file mode 100644 index 0000000..84785ea --- /dev/null +++ b/docs/uncov-web/01-name.md @@ -0,0 +1,5 @@ +NAME +==== + +uncov-web is a HTTP-server that provides Web-UI for browsing coverage +information collected by **uncov(1)**. diff --git a/docs/uncov-web/02-synopsis.md b/docs/uncov-web/02-synopsis.md new file mode 100644 index 0000000..92316d4 --- /dev/null +++ b/docs/uncov-web/02-synopsis.md @@ -0,0 +1,8 @@ +SYNOPSIS +======== + +**uncov-web** **-h|--help** + +**uncov-web** **-v|--version** + +**uncov-web** **--vhost** \ **--ip** [=0.0.0.0] **--repo** [=.] **--port** [=8000] diff --git a/docs/uncov-web/03-options.md b/docs/uncov-web/03-options.md new file mode 100644 index 0000000..df81e86 --- /dev/null +++ b/docs/uncov-web/03-options.md @@ -0,0 +1,32 @@ +OPTIONS +======= + +**--help, -h** +-------------- + +Displays short usage help. + +**--version, -v** +----------------- + +Displays version information. + +**--vhost** \ +------------------------- + +Sets virtual host name. This option is mandatory. + +**--ip** [=0.0.0.0] +------------------- + +IP address to bind to. The default is to bind to all interfaces. + +**--repo** [=.] +--------------- + +Path to repository. + +**--port** [=8000] +------------------ + +Post to listen on. diff --git a/docs/uncov-web/04-description.md b/docs/uncov-web/04-description.md new file mode 100644 index 0000000..c4c9576 --- /dev/null +++ b/docs/uncov-web/04-description.md @@ -0,0 +1,16 @@ +DESCRIPTION +=========== + +Once started provides HTTP-server to view coverage reports. Does not daemonize +itself. + +Notations +--------- + +For the sake of brevity interface uses several intuitive abbreviations: + + * Cov - coverage; + * Ref - reference (of VCS); + * C - covered; + * M - missed; + * R - relevant. diff --git a/docs/uncov-web/05-files.md b/docs/uncov-web/05-files.md new file mode 100644 index 0000000..c95a10f --- /dev/null +++ b/docs/uncov-web/05-files.md @@ -0,0 +1,4 @@ +FILES +===== + +**\/uncov.sqlite** -- storage of coverage data. diff --git a/docs/uncov-web/06-see-also.md b/docs/uncov-web/06-see-also.md new file mode 100644 index 0000000..000adf7 --- /dev/null +++ b/docs/uncov-web/06-see-also.md @@ -0,0 +1,4 @@ +SEE ALSO +======== + +**uncov(1)**, **uncov-gcov**(1) diff --git a/docs/uncov.1 b/docs/uncov.1 index 8580cbf..69d8a24 100644 --- a/docs/uncov.1 +++ b/docs/uncov.1 @@ -420,5 +420,8 @@ Prints files of \f[B]\f[] (or last build) located under .PP \f[B]/uncov.sqlite\f[] \-\- storage of coverage data. +.SH SEE ALSO +.PP +\f[B]uncov\-gcov\f[](1), \f[B]uncov\-web\f[](1) .SH AUTHORS xaizek . diff --git a/docs/uncov/08-see-also.md b/docs/uncov/08-see-also.md new file mode 100644 index 0000000..1bca46d --- /dev/null +++ b/docs/uncov/08-see-also.md @@ -0,0 +1,4 @@ +SEE ALSO +======== + +**uncov-gcov**(1), **uncov-web**(1) From c586f1734975e0da95e141331fdf2f14ca82a74d Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:56:31 +0300 Subject: [PATCH 5/6] Mark code documentation task as done It has been for a while now. --- TODO.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/TODO.md b/TODO.md index 571bdb5..bcefa7a 100644 --- a/TODO.md +++ b/TODO.md @@ -132,12 +132,6 @@ Or should this be handled by coverage providers? It's slow for huge diffs/files (quite understandable). -## More code documentation comments. ## - -| ID | Status | Type | -|------|---------------|--------| -| ZRY | in progress | task | - ## Language detection for file highlight relies on file name only. ## | ID | Status | Type | From 1684b63c5fd2a78c14048e78cf4a9fbe54240aa2 Mon Sep 17 00:00:00 2001 From: xaizek Date: Mon, 18 Sep 2017 17:59:21 +0300 Subject: [PATCH 6/6] Fix what INSTALL says about build mans And remove unused part of the Makefile. --- INSTALL.md | 2 +- Makefile | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index fe846eb..8345c3f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -34,7 +34,7 @@ Builds debug version with undefined and address sanitizers enabled in **`man`** -Rebuilds manual pages in `/docs/`, requires `pandoc`. +Rebuilds manual pages in `docs/`, requires `pandoc`. **`doxygen`** diff --git a/Makefile b/Makefile index 97f9a8b..5a7f959 100644 --- a/Makefile +++ b/Makefile @@ -124,7 +124,7 @@ self-coverage: coverage man: docs/uncov.1 docs/uncov-gcov.1 docs/uncov-web.1 # the following targets don't depend on $(wildcard docs/*/*.md) to make pandoc # optional -docs/uncov.1: force | $(out_dir)/docs/uncov +docs/uncov.1: force pandoc -V title=uncov \ -V section=1 \ -V app=uncov \ @@ -132,7 +132,7 @@ docs/uncov.1: force | $(out_dir)/docs/uncov -V date="$$(date +'%B %d, %Y')" \ -V author='xaizek ' \ -s -o $@ $(sort $(wildcard docs/uncov/*.md)) -docs/uncov-gcov.1: force | $(out_dir)/docs/uncov-gcov +docs/uncov-gcov.1: force pandoc -V title=uncov-gcov \ -V section=1 \ -V app=uncov-gcov \ @@ -140,7 +140,7 @@ docs/uncov-gcov.1: force | $(out_dir)/docs/uncov-gcov -V date="$$(date +'%B %d, %Y')" \ -V author='xaizek ' \ -s -o $@ $(sort $(wildcard docs/uncov-gcov/*.md)) -docs/uncov-web.1: force | $(out_dir)/docs/uncov-web +docs/uncov-web.1: force pandoc -V title=uncov-web \ -V section=1 \ -V app=uncov-web \