/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-ctl">
5
 
<!ENTITY TIMESTAMP "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-07-29">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2016</year>
41
41
      <year>2017</year>
42
42
      <year>2018</year>
 
43
      <year>2019</year>
43
44
      <holder>Teddy Hogeborn</holder>
44
45
      <holder>Björn Påhlsson</holder>
45
46
    </copyright>
61
62
  <refsynopsisdiv>
62
63
    <cmdsynopsis>
63
64
      <command>&COMMANDNAME;</command>
 
65
      <group>
 
66
          <arg choice="plain"><option>--verbose</option></arg>
 
67
          <arg choice="plain"><option>-v</option></arg>
 
68
          <sbr/>
 
69
          <arg choice="plain"><option>--dump-json</option></arg>
 
70
          <arg choice="plain"><option>-j</option></arg>
 
71
      </group>
 
72
      <arg><option>--debug</option></arg>
 
73
      <group>
 
74
        <arg rep='repeat' choice='plain'>
 
75
          <replaceable>CLIENT</replaceable>
 
76
        </arg>
 
77
      </group>
 
78
    </cmdsynopsis>
 
79
    <cmdsynopsis>
 
80
      <command>&COMMANDNAME;</command>
64
81
      <group choice="req">
65
82
        <group>
66
83
          <arg choice="plain"><option>--enable</option></arg>
77
94
        <sbr/>
78
95
        <group>
79
96
          <arg choice="plain"><option>--start-checker</option></arg>
80
 
        </group>
81
 
        <sbr/>
82
 
        <group>
83
97
          <arg choice="plain"><option>--stop-checker</option></arg>
84
98
        </group>
85
99
        <sbr/>
86
100
        <group>
87
 
          <arg choice="plain"><option>--remove</option></arg>
88
 
          <arg choice="plain"><option>-r</option></arg>
89
 
        </group>
90
 
        <sbr/>
91
 
        <group>
92
101
          <arg choice="plain"><option>--checker
93
102
          <replaceable>COMMAND</replaceable></option></arg>
94
103
          <arg choice="plain"><option>-c
132
141
        </group>
133
142
        <sbr/>
134
143
        <group>
135
 
          <arg choice="plain"><option>--interval
136
 
          <replaceable>TIME</replaceable></option></arg>
137
 
          <arg choice="plain"><option>-i
138
 
          <replaceable>TIME</replaceable></option></arg>
139
 
        </group>
140
 
        <sbr/>
141
 
        <group>
142
144
          <arg choice="plain"><option>--host
143
145
          <replaceable>STRING</replaceable></option></arg>
144
146
          <arg choice="plain"><option>-H
161
163
        </group>
162
164
      </group>
163
165
      <sbr/>
 
166
      <arg><option>--debug</option></arg>
164
167
      <group choice="req">
165
168
        <arg choice="plain"><option>--all</option></arg>
166
169
        <arg choice="plain"><option>-a</option></arg>
172
175
    <cmdsynopsis>
173
176
      <command>&COMMANDNAME;</command>
174
177
      <group>
175
 
          <arg choice="plain"><option>--verbose</option></arg>
176
 
          <arg choice="plain"><option>-v</option></arg>
177
 
          <sbr/>
178
 
          <arg choice="plain"><option>--dump-json</option></arg>
179
 
          <arg choice="plain"><option>-j</option></arg>
180
 
      </group>
181
 
      <group>
 
178
        <arg choice="plain"><option>--deny</option></arg>
 
179
        <arg choice="plain"><option>-D</option></arg>
 
180
      </group>
 
181
      <group choice="req">
 
182
          <arg choice="plain"><option>--remove</option></arg>
 
183
          <arg choice="plain"><option>-r</option></arg>
 
184
      </group>
 
185
      <sbr/>
 
186
      <arg><option>--debug</option></arg>
 
187
      <group choice="req">
 
188
        <arg choice="plain"><option>--all</option></arg>
 
189
        <arg choice="plain"><option>-a</option></arg>
182
190
        <arg rep='repeat' choice='plain'>
183
191
          <replaceable>CLIENT</replaceable>
184
192
        </arg>
190
198
        <arg choice="plain"><option>--is-enabled</option></arg>
191
199
        <arg choice="plain"><option>-V</option></arg>
192
200
      </group>
 
201
      <arg><option>--debug</option></arg>
193
202
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
194
203
    </cmdsynopsis>
195
204
    <cmdsynopsis>
503
512
      </varlistentry>
504
513
      
505
514
      <varlistentry>
 
515
        <term><option>--debug</option></term>
 
516
        <listitem>
 
517
          <para>
 
518
            Show debug output; currently, this means show D-Bus calls.
 
519
          </para>
 
520
        </listitem>
 
521
      </varlistentry>
 
522
      
 
523
      <varlistentry>
506
524
        <term><option>--check</option></term>
507
525
        <listitem>
508
526
          <para>
539
557
  
540
558
  <refsect1 id="example">
541
559
    <title>EXAMPLE</title>
 
560
    <!-- Name of test methods in class Test_commands_from_options are
 
561
         written in comments below.  When adding an example, add a
 
562
         test too which tests the documented behavior. -->
542
563
    <informalexample>
 
564
      <!-- Test method: test_manual_page_example_1() -->
543
565
      <para>
544
566
        To list all clients:
545
567
      </para>
549
571
    </informalexample>
550
572
    
551
573
    <informalexample>
 
574
      <!-- Test method: test_manual_page_example_2() -->
552
575
      <para>
553
576
        To list <emphasis>all</emphasis> settings for the clients
554
577
        named <quote>foo1.example.org</quote> and <quote
563
586
    </informalexample>
564
587
    
565
588
    <informalexample>
 
589
      <!-- Test method: test_manual_page_example_3() -->
566
590
      <para>
567
591
        To enable all clients:
568
592
      </para>
572
596
    </informalexample>
573
597
    
574
598
    <informalexample>
 
599
      <!-- Test method: test_manual_page_example_4() -->
575
600
      <para>
576
601
        To change timeout and interval value for the clients
577
602
        named <quote>foo1.example.org</quote> and <quote
580
605
      <para>
581
606
 
582
607
<!-- do not wrap this line -->
583
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
608
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
584
609
 
585
610
      </para>
586
611
    </informalexample>
587
612
    
588
613
    <informalexample>
 
614
      <!-- Test method: test_manual_page_example_5() -->
589
615
      <para>
590
 
        To approve all clients currently waiting for it:
 
616
        To approve all clients currently waiting for approval:
591
617
      </para>
592
618
      <para>
593
619
        <userinput>&COMMANDNAME; --approve --all</userinput>