/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 plugins.d/splashy.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:
plugins.d/splashy.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 "splashy">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
36
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
126
135
        <para>
127
136
          These variables will normally be inherited from
128
137
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
129
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
130
 
          normally have inherited them from
131
 
          <filename>/scripts/local-top/cryptroot</filename> in the
132
 
          initial <acronym>RAM</acronym> disk environment, which will
133
 
          have set them from parsing kernel arguments and
134
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
135
 
          initial RAM disk environment), which in turn will have been
136
 
          created when the initial RAM disk image was created by
137
 
          <filename
138
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
139
 
          extracting the information of the root file system from
140
 
          <filename >/etc/crypttab</filename>.
 
138
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
139
          have in turn inherited them from its calling process.
141
140
        </para>
142
141
        <para>
143
142
          This behavior is meant to exactly mirror the behavior of
203
202
      is ugly, but necessary as long as it does not support aborting a
204
203
      password request.
205
204
    </para>
 
205
    <xi:include href="../bugs.xml"/>
206
206
  </refsect1>
207
207
  
208
208
  <refsect1 id="example">
266
266
    <para>
267
267
      <citerefentry><refentrytitle>intro</refentrytitle>
268
268
      <manvolnum>8mandos</manvolnum></citerefentry>,
269
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
270
 
      <manvolnum>5</manvolnum></citerefentry>,
271
269
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
272
270
      <manvolnum>8mandos</manvolnum></citerefentry>,
273
271
      <citerefentry><refentrytitle>proc</refentrytitle>