/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 "2019-03-09">
 
5
<!ENTITY TIMESTAMP "2019-07-29">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
557
557
  
558
558
  <refsect1 id="example">
559
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. -->
560
563
    <informalexample>
 
564
      <!-- Test method: test_manual_page_example_1() -->
561
565
      <para>
562
566
        To list all clients:
563
567
      </para>
567
571
    </informalexample>
568
572
    
569
573
    <informalexample>
 
574
      <!-- Test method: test_manual_page_example_2() -->
570
575
      <para>
571
576
        To list <emphasis>all</emphasis> settings for the clients
572
577
        named <quote>foo1.example.org</quote> and <quote
581
586
    </informalexample>
582
587
    
583
588
    <informalexample>
 
589
      <!-- Test method: test_manual_page_example_3() -->
584
590
      <para>
585
591
        To enable all clients:
586
592
      </para>
590
596
    </informalexample>
591
597
    
592
598
    <informalexample>
 
599
      <!-- Test method: test_manual_page_example_4() -->
593
600
      <para>
594
601
        To change timeout and interval value for the clients
595
602
        named <quote>foo1.example.org</quote> and <quote
598
605
      <para>
599
606
 
600
607
<!-- do not wrap this line -->
601
 
<userinput>&COMMANDNAME; --timeout="PT5M" --interval="PT1M" foo1.example.org foo2.example.org</userinput>
 
608
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
602
609
 
603
610
      </para>
604
611
    </informalexample>
605
612
    
606
613
    <informalexample>
 
614
      <!-- Test method: test_manual_page_example_5() -->
607
615
      <para>
608
 
        To approve all clients currently waiting for it:
 
616
        To approve all clients currently waiting for approval:
609
617
      </para>
610
618
      <para>
611
619
        <userinput>&COMMANDNAME; --approve --all</userinput>