/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:
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 "2016-06-27">
 
5
<!ENTITY TIMESTAMP "2019-07-29">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
38
38
      <year>2014</year>
39
39
      <year>2015</year>
40
40
      <year>2016</year>
 
41
      <year>2017</year>
 
42
      <year>2018</year>
 
43
      <year>2019</year>
41
44
      <holder>Teddy Hogeborn</holder>
42
45
      <holder>Björn Påhlsson</holder>
43
46
    </copyright>
59
62
  <refsynopsisdiv>
60
63
    <cmdsynopsis>
61
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>
62
81
      <group choice="req">
63
82
        <group>
64
83
          <arg choice="plain"><option>--enable</option></arg>
75
94
        <sbr/>
76
95
        <group>
77
96
          <arg choice="plain"><option>--start-checker</option></arg>
78
 
        </group>
79
 
        <sbr/>
80
 
        <group>
81
97
          <arg choice="plain"><option>--stop-checker</option></arg>
82
98
        </group>
83
99
        <sbr/>
84
100
        <group>
85
 
          <arg choice="plain"><option>--remove</option></arg>
86
 
          <arg choice="plain"><option>-r</option></arg>
87
 
        </group>
88
 
        <sbr/>
89
 
        <group>
90
101
          <arg choice="plain"><option>--checker
91
102
          <replaceable>COMMAND</replaceable></option></arg>
92
103
          <arg choice="plain"><option>-c
130
141
        </group>
131
142
        <sbr/>
132
143
        <group>
133
 
          <arg choice="plain"><option>--interval
134
 
          <replaceable>TIME</replaceable></option></arg>
135
 
          <arg choice="plain"><option>-i
136
 
          <replaceable>TIME</replaceable></option></arg>
137
 
        </group>
138
 
        <sbr/>
139
 
        <group>
140
144
          <arg choice="plain"><option>--host
141
145
          <replaceable>STRING</replaceable></option></arg>
142
146
          <arg choice="plain"><option>-H
159
163
        </group>
160
164
      </group>
161
165
      <sbr/>
 
166
      <arg><option>--debug</option></arg>
162
167
      <group choice="req">
163
168
        <arg choice="plain"><option>--all</option></arg>
164
169
        <arg choice="plain"><option>-a</option></arg>
170
175
    <cmdsynopsis>
171
176
      <command>&COMMANDNAME;</command>
172
177
      <group>
173
 
          <arg choice="plain"><option>--verbose</option></arg>
174
 
          <arg choice="plain"><option>-v</option></arg>
175
 
          <sbr/>
176
 
          <arg choice="plain"><option>--dump-json</option></arg>
177
 
          <arg choice="plain"><option>-j</option></arg>
178
 
      </group>
179
 
      <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>
180
190
        <arg rep='repeat' choice='plain'>
181
191
          <replaceable>CLIENT</replaceable>
182
192
        </arg>
188
198
        <arg choice="plain"><option>--is-enabled</option></arg>
189
199
        <arg choice="plain"><option>-V</option></arg>
190
200
      </group>
 
201
      <arg><option>--debug</option></arg>
191
202
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
192
203
    </cmdsynopsis>
193
204
    <cmdsynopsis>
501
512
      </varlistentry>
502
513
      
503
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>
504
524
        <term><option>--check</option></term>
505
525
        <listitem>
506
526
          <para>
537
557
  
538
558
  <refsect1 id="example">
539
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. -->
540
563
    <informalexample>
 
564
      <!-- Test method: test_manual_page_example_1() -->
541
565
      <para>
542
566
        To list all clients:
543
567
      </para>
547
571
    </informalexample>
548
572
    
549
573
    <informalexample>
 
574
      <!-- Test method: test_manual_page_example_2() -->
550
575
      <para>
551
576
        To list <emphasis>all</emphasis> settings for the clients
552
577
        named <quote>foo1.example.org</quote> and <quote
561
586
    </informalexample>
562
587
    
563
588
    <informalexample>
 
589
      <!-- Test method: test_manual_page_example_3() -->
564
590
      <para>
565
591
        To enable all clients:
566
592
      </para>
570
596
    </informalexample>
571
597
    
572
598
    <informalexample>
 
599
      <!-- Test method: test_manual_page_example_4() -->
573
600
      <para>
574
601
        To change timeout and interval value for the clients
575
602
        named <quote>foo1.example.org</quote> and <quote
578
605
      <para>
579
606
 
580
607
<!-- do not wrap this line -->
581
 
<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>
582
609
 
583
610
      </para>
584
611
    </informalexample>
585
612
    
586
613
    <informalexample>
 
614
      <!-- Test method: test_manual_page_example_5() -->
587
615
      <para>
588
 
        To approve all clients currently waiting for it:
 
616
        To approve all clients currently waiting for approval:
589
617
      </para>
590
618
      <para>
591
619
        <userinput>&COMMANDNAME; --approve --all</userinput>