Skip to content

Commit cdb2db3

Browse files
xaizekxaizek
committed
Update docs for newer pandoc version
1 parent 95fa29e commit cdb2db3

File tree

7 files changed

+174
-131
lines changed

7 files changed

+174
-131
lines changed

‎docs/uncov-gcov.1‎

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
.\" Automatically generated by Pandoc 2.13
1+
.\" Automatically generated by Pandoc 2.17.1.1
22
.\"
3-
.TH "uncov-gcov" "1" "November 14, 2021" "uncov v0.4" ""
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "uncov-gcov" "1" "November 18, 2022" "uncov v0.4" ""
418
.hy
519
.SH NAME
620
.PP
@@ -16,45 +30,45 @@ It might be a good idea to switch to using \[lq]uncov new-gcovi\[rq]
1630
subcommand.
1731
.SH SYNOPSIS
1832
.PP
19-
\f[B]uncov-gcov\f[R] \f[B]-h|\[en]help\f[R]
33+
\f[B]uncov-gcov\f[R] \f[B]-h|--help\f[R]
2034
.PP
21-
\f[B]uncov-gcov\f[R] \f[B]-v|\[en]version\f[R]
35+
\f[B]uncov-gcov\f[R] \f[B]-v|--version\f[R]
2236
.PP
2337
\f[B]uncov-gcov\f[R] \f[B][<options>\&...]\f[R]
2438
.SH OPTIONS
25-
.SS \f[B]\[en]help, -h\f[R]
39+
.SS \f[B]--help, -h\f[R]
2640
.PP
2741
Displays short usage help.
28-
.SS \f[B]\[en]version, -v\f[R]
42+
.SS \f[B]--version, -v\f[R]
2943
.PP
3044
Displays version information.
31-
.SS \f[B]\[en]verbose\f[R]
45+
.SS \f[B]--verbose\f[R]
3246
.PP
3347
Print verbose messages.
34-
.SS \f[B]\[en]dryrun\f[R]
48+
.SS \f[B]--dryrun\f[R]
3549
.PP
3650
Run the script without printing report.
37-
.SS \f[B]\[en]gcov\f[R] [=gcov]
51+
.SS \f[B]--gcov\f[R] [=gcov]
3852
.PP
3953
Set the location of gcov.
40-
.SS \f[B]\[en]gcov-options\f[R] [=\[dq]\[dq]]
54+
.SS \f[B]--gcov-options\f[R] [=\[lq]\[rq]]
4155
.PP
4256
Set the options given to gcov.
43-
.SS \f[B]-r\f[R], \f[B]\[en]root\f[R] [=.]
57+
.SS \f[B]-r\f[R], \f[B]--root\f[R] [=.]
4458
.PP
4559
Set the root directory.
46-
.SS \f[B]-b\f[R], \f[B]\[en]build-root\f[R] [={discovered}]
60+
.SS \f[B]-b\f[R], \f[B]--build-root\f[R] [={discovered}]
4761
.PP
4862
Set the directory from which gcov will be called; by default gcov is run
4963
in the directory of the .o files; however the paths of the sources are
5064
often relative to the directory from which the compiler was run and
5165
these relative paths are saved in the .o file; when this happens, gcov
5266
needs to run in the same directory as the compiler in order to find the
5367
source files.
54-
.SS \f[B]\[en]collect-root\f[R] [={value of \[en]root}]
68+
.SS \f[B]--collect-root\f[R] [={value of --root}]
5569
.PP
5670
Directory to look gcov files in.
57-
.SS \f[B]-e\f[R], \f[B]\[en]exclude\f[R] [=\[dq]\[dq]]
71+
.SS \f[B]-e\f[R], \f[B]--exclude\f[R] [=\[lq]\[rq]]
5872
.PP
5973
List of paths to exclude.
6074
Can be specifieid multiple times.
@@ -63,44 +77,44 @@ Examples:
6377
.IP
6478
.nf
6579
\f[C]
66-
uncov-gcov --exclude build-release --exclude build-debug ...
67-
uncov-gcov --exclude build-release build-debug ...
68-
uncov-gcov --exclude build* ...
80+
uncov-gcov -\[rs]-exclude build-release -\[rs]-exclude build-debug ...
81+
uncov-gcov -\[rs]-exclude build-release build-debug ...
82+
uncov-gcov -\[rs]-exclude build* ...
6983
\f[R]
7084
.fi
71-
.SS \f[B]-i\f[R], \f[B]\[en]include\f[R] [=\[dq]\[dq]]
85+
.SS \f[B]-i\f[R], \f[B]--include\f[R] [=\[lq]\[rq]]
7286
.PP
7387
List of paths to include.
7488
Can be specifieid multiple times.
75-
See \f[B]\[en]exclude\f[R] for examples.
76-
.SS \f[B]-E\f[R], \f[B]\[en]exclude-pattern\f[R] [=\[dq]\[dq]]
89+
See \f[B]--exclude\f[R] for examples.
90+
.SS \f[B]-E\f[R], \f[B]--exclude-pattern\f[R] [=\[lq]\[rq]]
7791
.PP
7892
Set exclude file/directory pattern.
79-
.SS \f[B]-x\f[R], \f[B]\[en]extension\f[R] [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm]
93+
.SS \f[B]-x\f[R], \f[B]--extension\f[R] [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm]
8094
.PP
8195
Set extension of files to process.
82-
.SS \f[B]-n\f[R], \f[B]\[en]no-gcov\f[R]
96+
.SS \f[B]-n\f[R], \f[B]--no-gcov\f[R]
8397
.PP
8498
Do not run gcov.
85-
.SS \f[B]\[en]encodings\f[R] [=utf-8,latin-1]
99+
.SS \f[B]--encodings\f[R] [=utf-8,latin-1]
86100
.PP
87101
Source encodings to try in order of preference.
88-
.SS \f[B]\[en]dump\f[R] <file>
102+
.SS \f[B]--dump\f[R] <file>
89103
.PP
90104
Dump JSON payload to a file.
91-
.SS \f[B]\[en]follow-symlinks\f[R]
105+
.SS \f[B]--follow-symlinks\f[R]
92106
.PP
93107
Follow symlinks.
94-
.SS \f[B]-c\f[R], \f[B]\[en]capture-worktree\f[R]
108+
.SS \f[B]-c\f[R], \f[B]--capture-worktree\f[R]
95109
.PP
96110
Make a dangling commit if working directory is dirty.
97-
.SS \f[B]\[en]ref-name\f[R] [={discovered}]
111+
.SS \f[B]--ref-name\f[R] [={discovered}]
98112
.PP
99113
Force custom ref name.
100-
.SS \f[B]\[en]cpp-dtor-invocations\f[R]
114+
.SS \f[B]--cpp-dtor-invocations\f[R]
101115
.PP
102116
Count coverage for C++ destructor invocations, which tends to show up at
103-
lines that have the closing brace (\f[C]{\f[R]).
117+
lines that have the closing brace (\f[V]{\f[R]).
104118
.SH USAGE
105119
.PP
106120
uncov-gcov can be used to generate coverage, but it seems to not play
@@ -118,9 +132,9 @@ find . -name \[aq]*.gcda\[aq] -delete
118132
# generage coverage for every object file found (change \[dq].\[dq] to build root)
119133
find . -name \[aq]*.o\[aq] -exec gcov -p {} +
120134

121-
# generage and combine coverage reports (--capture-worktree automatically
135+
# generage and combine coverage reports (-\[rs]-capture-worktree automatically
122136
# makes stray commit if repository is dirty)
123-
uncov-gcov --root . --no-gcov --capture-worktree --exclude tests | uncov new
137+
uncov-gcov -\[rs]-root . -\[rs]-no-gcov -\[rs]-capture-worktree -\[rs]-exclude tests | uncov new
124138

125139
# remove coverage reports
126140
find . -name \[aq]*.gcov\[aq] -delete

‎docs/uncov-gcov/02-synopsis.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
SYNOPSIS
22
========
33

4-
**uncov-gcov** **-h|--help**
4+
**uncov-gcov** **-h|-\-help**
55

6-
**uncov-gcov** **-v|--version**
6+
**uncov-gcov** **-v|-\-version**
77

88
**uncov-gcov** **[\<options\>...]**

‎docs/uncov-gcov/03-options.md‎

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,114 @@
11
OPTIONS
22
=======
33

4-
**--help, -h**
5-
--------------
4+
**-\-help, -h**
5+
---------------
66

77
Displays short usage help.
88

9-
**--version, -v**
10-
-----------------
9+
**-\-version, -v**
10+
------------------
1111

1212
Displays version information.
1313

14-
**--verbose**
15-
-------------
14+
**-\-verbose**
15+
--------------
1616

1717
Print verbose messages.
1818

19-
**--dryrun**
20-
------------
19+
**-\-dryrun**
20+
-------------
2121

2222
Run the script without printing report.
2323

24-
**--gcov** [=gcov]
25-
------------------
24+
**-\-gcov** [=gcov]
25+
-------------------
2626

2727
Set the location of gcov.
2828

29-
**--gcov-options** [=""]
30-
------------------------
29+
**-\-gcov-options** [=""]
30+
-------------------------
3131

3232
Set the options given to gcov.
3333

34-
**-r**, **--root** [=.]
35-
-----------------------
34+
**-r**, **-\-root** [=.]
35+
------------------------
3636

3737
Set the root directory.
3838

39-
**-b**, **--build-root** [={discovered}]
40-
----------------------------------------
39+
**-b**, **-\-build-root** [={discovered}]
40+
-----------------------------------------
4141

4242
Set the directory from which gcov will be called; by default gcov is run in the
4343
directory of the .o files; however the paths of the sources are often relative
4444
to the directory from which the compiler was run and these relative paths are
4545
saved in the .o file; when this happens, gcov needs to run in the same directory
4646
as the compiler in order to find the source files.
4747

48-
**--collect-root** [={value of --root}]
49-
---------------------------------------
48+
**-\-collect-root** [={value of -\-root}]
49+
----------------------------------------
5050

5151
Directory to look gcov files in.
5252

53-
**-e**, **--exclude** [=""]
54-
---------------------------
53+
**-e**, **-\-exclude** [=""]
54+
----------------------------
5555

5656
List of paths to exclude. Can be specifieid multiple times.
5757

5858
Examples:
5959

60-
uncov-gcov --exclude build-release --exclude build-debug ...
61-
uncov-gcov --exclude build-release build-debug ...
62-
uncov-gcov --exclude build* ...
60+
uncov-gcov -\-exclude build-release -\-exclude build-debug ...
61+
uncov-gcov -\-exclude build-release build-debug ...
62+
uncov-gcov -\-exclude build* ...
6363

64-
**-i**, **--include** [=""]
65-
---------------------------
64+
**-i**, **-\-include** [=""]
65+
----------------------------
6666

67-
List of paths to include. Can be specifieid multiple times. See **--exclude**
67+
List of paths to include. Can be specifieid multiple times. See **-\-exclude**
6868
for examples.
6969

70-
**-E**, **--exclude-pattern** [=""]
71-
-----------------------------------
70+
**-E**, **-\-exclude-pattern** [=""]
71+
------------------------------------
7272

7373
Set exclude file/directory pattern.
7474

75-
**-x**, **--extension** [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm]
76-
-------------------------------------------------------------------
75+
**-x**, **-\-extension** [=.h,.hh,.hpp,.hxx,.c,.cc,.cpp,.cxx,.m,.mm]
76+
--------------------------------------------------------------------
7777

7878
Set extension of files to process.
7979

80-
**-n**, **--no-gcov**
81-
---------------------
80+
**-n**, **-\-no-gcov**
81+
----------------------
8282

8383
Do not run gcov.
8484

85-
**--encodings** [=utf-8,latin-1]
86-
--------------------------------
85+
**-\-encodings** [=utf-8,latin-1]
86+
---------------------------------
8787

8888
Source encodings to try in order of preference.
8989

90-
**--dump** \<file\>
91-
-------------------
90+
**-\-dump** \<file\>
91+
--------------------
9292

9393
Dump JSON payload to a file.
9494

95-
**--follow-symlinks**
96-
---------------------
95+
**-\-follow-symlinks**
96+
----------------------
9797

9898
Follow symlinks.
9999

100-
**-c**, **--capture-worktree**
101-
------------------------------
100+
**-c**, **-\-capture-worktree**
101+
-------------------------------
102102

103103
Make a dangling commit if working directory is dirty.
104104

105-
**--ref-name** [={discovered}]
106-
------------------------------
105+
**-\-ref-name** [={discovered}]
106+
-------------------------------
107107

108108
Force custom ref name.
109109

110-
**--cpp-dtor-invocations**
111-
--------------------------
110+
**-\-cpp-dtor-invocations**
111+
---------------------------
112112

113113
Count coverage for C++ destructor invocations, which tends to show up at lines
114114
that have the closing brace (`{`).

‎docs/uncov-gcov/04-usage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ find . -name '*.gcda' -delete
1414
# generage coverage for every object file found (change "." to build root)
1515
find . -name '*.o' -exec gcov -p {} +
1616
17-
# generage and combine coverage reports (--capture-worktree automatically
17+
# generage and combine coverage reports (-\-capture-worktree automatically
1818
# makes stray commit if repository is dirty)
19-
uncov-gcov --root . --no-gcov --capture-worktree --exclude tests | uncov new
19+
uncov-gcov -\-root . -\-no-gcov -\-capture-worktree -\-exclude tests | uncov new
2020
2121
# remove coverage reports
2222
find . -name '*.gcov' -delete

‎docs/uncov-web.1‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
.\" Automatically generated by Pandoc 2.13
1+
.\" Automatically generated by Pandoc 2.17.1.1
22
.\"
3-
.TH "uncov-web" "1" "November 14, 2021" "uncov v0.4" ""
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "uncov-web" "1" "November 18, 2022" "uncov v0.4" ""
418
.hy
519
.SH NAME
620
.PP
@@ -13,7 +27,8 @@ information collected by \f[B]uncov(1)\f[R].
1327
\f[B]uncov-web\f[R] \f[B]-v|--version\f[R]
1428
.PP
1529
\f[B]uncov-web\f[R] \f[B]--vhost\f[R] <host-name> \f[B]--ip\f[R]
16-
[=0.0.0.0] \f[B]--repo\f[R] [=.] \f[B]--port\f[R] [=8000]
30+
[=0.0.0.0] \f[B]--repo\f[R] [=.]
31+
\f[B]--port\f[R] [=8000]
1732
.SH OPTIONS
1833
.SS \f[B]--help, -h\f[R]
1934
.PP

0 commit comments

Comments
 (0)