.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GENDESC" "1" "2026-07-07" "2.5" "LCOV"
.SH NAME
gendesc \- gendesc documentation
.INDENT 0.0
.TP
.B Manual section
1
.TP
.B Manual group
LCOV 2.5
.UNINDENT
.SH NAME
.INDENT 0.0
.TP
.B gendesc
Generate a test case description file (internal application)
.UNINDENT
.SH SYNOPSIS
.INDENT 0.0
.TP
\fBgendesc\fP [ \fB\-h\fP | \fB–help\fP ] [ \fB\-v\fP | \fB–version\fP ]
[ \fB\-o\fP | \fB–output\-filename\fP \fIfilename\fP ]
\fIinputfile\fP
.UNINDENT
.SH DESCRIPTION
.sp
Convert plain text test case descriptions into a format as understood by
\fBgenhtml\fP\&. \fIinputfile\fP needs to observe the following format:
.sp
For each test case:
.INDENT 0.0
.IP \(bu 2
one line containing the test case name beginning at the start of the line
.IP \(bu 2
one or more lines containing the test case description indented with at
least one whitespace character (tab or space)
.UNINDENT
.sp
\fBExample input file:\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
test01
    An example test case description.
    Description continued

test42
    Supposedly the answer to most of your questions
.EE
.UNINDENT
.UNINDENT
.sp
Note: valid test names can consist of letters, decimal digits and the
underscore character (‘_’).
.SH OPTIONS
.INDENT 0.0
.TP
\fB\-h\fP, \fB–help\fP
Print a short help text, then exit.
.TP
\fB\-v\fP, \fB–version\fP
Print version number, then exit.
.TP
\fB\-o\fP \fIfilename\fP, \fB–output\-filename\fP \fIfilename\fP
Write description data to \fIfilename\fP\&.
.sp
By default, output is written to STDOUT.
.UNINDENT
.SH AUTHOR
.sp
Peter Oberparleiter <\%<Peter\:.Oberparleiter@\:de\:.ibm\:.com>>
.SH SEE ALSO
.sp
\fBlcov(1) \%<file://\:\:../\:man/\:lcov\:.1\:.html>\fP, \fBgenhtml(1) \%<file://\:\:../\:man/\:genhtml\:.1\:.html>\fP, \fBgeninfo(1) \%<file://\:\:../\:man/\:geninfo\:.1\:.html>\fP, \fBgenpng(1) \%<file://\:\:../\:man/\:genpng\:.1\:.html>\fP, \fBgcov(1) \%<file://\:\:../\:man/\:gcov\:.1\:.html>\fP
.sp
\%<https://\:github\:.com/\:linux-test-project/\:lcov>
.SH Copyright
2024-2026, LCOV Project
.\" End of generated man page.