docs: Improve man page consistency

Make Options sections refsect1 instead of refsect2, and use
uppercase for argument names. Also add a product name, and
shorten some argument names.
This commit is contained in:
Matthias Clasen
2012-08-03 00:36:25 +02:00
parent d241978412
commit 08dd0f246a
13 changed files with 506 additions and 371 deletions

View File

@@ -1,5 +1,17 @@
<refentry id="glib-gettextize" lang="en">
<refentryinfo>
<title>glib-gettextize</title>
<productname>GLib</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Owen</firstname>
<surname>Taylor</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>glib-gettextize</refentrytitle>
<manvolnum>1</manvolnum>
@@ -14,8 +26,8 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>glib-gettextize</command>
<arg choice="opt" rep="repeat">option</arg>
<arg choice="opt">directory</arg>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="opt">DIRECTORY</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -33,7 +45,9 @@ from <command>gettextize</command> in that it doesn't create an
<command>gettextize</command> behave like this when called with the
<option>--no-changelog</option> option).
</para>
<refsect2><title>Options</title>
</refsect1>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
@@ -64,7 +78,6 @@ force writing of new files even if old ones exist
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1><title>See also</title>
@@ -73,5 +86,3 @@ force writing of new files even if old ones exist
</para>
</refsect1>
</refentry>

View File

@@ -1,5 +1,17 @@
<refentry id="gtester-report">
<refentryinfo>
<title>gtester-report</title>
<productname>GLib</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Tim</firstname>
<surname>Janik</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>gtester-report</refentrytitle>
<manvolnum>1</manvolnum>
@@ -23,8 +35,9 @@
<para><command>gtester-report</command> is a script which converts
the XML output generated by gtester into HTML.
</para>
</refsect1>
<refsect2><title>Options</title>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
@@ -42,7 +55,6 @@ print version information and exit
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1><title>See also</title>
@@ -54,5 +66,3 @@ print version information and exit
</para>
</refsect1>
</refentry>

View File

@@ -1,5 +1,22 @@
<refentry id="gtester">
<refentryinfo>
<title>gtester</title>
<productname>GLib</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Tim</firstname>
<surname>Janik</surname>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Sven</firstname>
<surname>Herzberg</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>gtester</refentrytitle>
<manvolnum>1</manvolnum>
@@ -14,7 +31,7 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>gtester</command>
<arg choice="opt" rep="repeat">option</arg>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg>testprogram</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -28,8 +45,9 @@ When called with the <option>-o</option> option, <command>gtester</command>
writes an XML report of the test results, which can be converted
into HTML using the <command>gtester-report</command> utility.
</para>
</refsect1>
<refsect2><title>Options</title>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
@@ -73,33 +91,43 @@ list paths of available test cases
run test cases in <replaceable>MODE</replaceable>, which can be one of:
<variablelist>
<varlistentry>
<term><option>perf</option></term>
<listitem><para>
run performance tests
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>slow</option>, <option>thorough</option></term>
<listitem><para>
run slow tests, or repeat non-deterministic tests more often
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>quick</option></term>
<listitem><para>
do not run slow or performance tests, or do extra repeats
of non-deterministic tests (default)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>undefined</option></term>
<listitem><para>
run test cases that deliberately provoke checks or assertion
failures, if implemented (default)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>no-undefined</option></term>
<listitem><para>
do not run test cases that deliberately provoke checks or
assertion failures
</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
@@ -148,7 +176,6 @@ report success per testcase
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1><title>See also</title>