Debian Codegraph @

man/gendesc.1

raw
1 \" Define project URL
2 .ds lcovurl https://github.com/linux\-test\-project/lcov
3
4 .TH gendesc 1 "LCOV 2.0" 2023\-05\-12 "User Manuals"
5 .SH NAME
6 gendesc \- Generate a test case description file
7 .SH SYNOPSIS
8 .B gendesc
9 .RB [ \-h | \-\-help ]
10 .RB [ \-v | \-\-version ]
11 .RS 8
12 .br
13 .RB [ \-o | \-\-output\-filename
14 .IR filename ]
15 .br
16 .I inputfile
17 .SH DESCRIPTION
18 Convert plain text test case descriptions into a format as understood by
19 .BR genhtml .
20 .I inputfile
21 needs to observe the following format:
22
23 For each test case:
24 .IP " \-"
25 one line containing the test case name beginning at the start of the line
26 .RE
27 .IP " \-"
28 one or more lines containing the test case description indented with at
29 least one whitespace character (tab or space)
30 .RE
31
32 .B Example input file:
33
34 test01
35 .RS
36 An example test case description.
37 .br
38 Description continued
39 .RE
40
41 test42
42 .RS
43 Supposedly the answer to most of your questions
44 .RE
45
46 Note: valid test names can consist of letters, decimal digits and the
47 underscore character ('_').
48 .SH OPTIONS
49 .B \-h
50 .br
51 .B \-\-help
52 .RS
53 Print a short help text, then exit.
54 .RE
55
56 .B \-v
57 .br
58 .B \-\-version
59 .RS
60 Print version number, then exit.
61 .RE
62
63
64 .BI "\-o " filename
65 .br
66 .BI "\-\-output\-filename " filename
67 .RS
68 Write description data to
69 .IR filename .
70
71 By default, output is written to STDOUT.
72 .RE
73 .SH AUTHOR
74 Peter Oberparleiter <[email protected]>
75
76 .SH SEE ALSO
77 .BR lcov (1),
78 .BR genhtml (1),
79 .BR geninfo (1),
80 .BR genpng (1),
81 .BR gcov (1)
82 .br
83
84 .I \*[lcovurl]
85 .br