[systemd-devel] [PATCH] Create journal-remote.conf.xml to document the format of the configuration file for systemd-journal-remote

[David Herrmann]

Hi

On Mon, Mar 16, 2015 at 1:49 PM, Chris Morgan <chmorgan at gmail.com> wrote:
> ---
>  man/journal-remote.conf.xml    | 111 +++++++++++++++++++++++++++++++++++++++++
>  man/systemd-journal-remote.xml |   1 +
>  2 files changed, 112 insertions(+)
>  create mode 100644 man/journal-remote.conf.xml
>
> diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml
> new file mode 100644
> index 0000000..84e07ee
> --- /dev/null
> +++ b/man/journal-remote.conf.xml
> @@ -0,0 +1,111 @@
> +<?xml version='1.0'?> <!--*-nxml-*-->
> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
> +  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
> +
> +<!--
> +  This file is part of systemd.
> +
> +  Copyright 2015 Chris Morgan
> +
> +  systemd is free software; you can redistribute it and/or modify it
> +  under the terms of the GNU Lesser General Public License as published by
> +  the Free Software Foundation; either version 2.1 of the License, or
> +  (at your option) any later version.
> +
> +  systemd is distributed in the hope that it will be useful, but
> +  WITHOUT ANY WARRANTY; without even the implied warranty of
> +  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +  Lesser General Public License for more details.
> +
> +  You should have received a copy of the GNU Lesser General Public License
> +  along with systemd; If not, see <http://www.gnu.org/licenses/>.
> +-->
> +
> +<refentry id="journal-remote.conf"
> +    xmlns:xi="http://www.w3.org/2001/XInclude">
> +  <refentryinfo>
> +    <title>journal-remote.conf</title>
> +    <productname>systemd</productname>
> +
> +    <authorgroup>
> +      <author>
> +        <contrib>Developer</contrib>
> +        <firstname>Chris</firstname>
> +        <surname>Morgan</surname>
> +        <email>chmorgan at gmail.com</email>
> +      </author>
> +    </authorgroup>
> +  </refentryinfo>
> +
> +  <refmeta>
> +    <refentrytitle>journal-remote.conf</refentrytitle>
> +    <manvolnum>5</manvolnum>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>journal-remote.conf</refname>

missing:
<refname>journal-remote.conf.d</refname>

> +    <refpurpose>Journal remote service configuration files</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <para><filename>/etc/systemd/journal-remote.conf</filename></para>
> +    <para><filename>/etc/journal-remote.conf</filename></para>
> +    <para><filename>/run/journal-remote.conf</filename></para>
> +    <para><filename>/usr/local/lib/journal-remote.conf</filename></para>
> +    <para><filename>/usr/lib/journal-remote.conf</filename></para>

Where do all these come from? Shouldn't these be the same as in
journal.conf.xml? Have a look at the CONF_DIRS_NULSTR macro in
src/shared/macro.h, which defines the lookup directories.

> +  </refsynopsisdiv>
> +
> +  <refsect1>
> +    <title>Description</title>
> +
> +    <para>These files configure various parameters of the systemd-remote-journal
> +    application,
> +    <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
> +
> +  </refsect1>
> +

How about:
<xi:include href="standard-conf.xml" xpointer="main-conf" />

> +  <refsect1>
> +    <title>Options</title>
> +
> +    <para>All options are configured in the
> +    <literal>[Journal]</literal> section:</para>

The section is called [Remote].

> +
> +    <variablelist>
> +
> +      <varlistentry>
> +        <term><varname>SplitMode=</varname></term>
> +
> +        <listitem><para>One of <literal>host</literal> or <literal>none</literal>.
> +        </para></listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>ServerKeyFile=</varname></term>
> +
> +        <listitem><para>SSL key in PEM format</para></listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>ServerCertificateFile=</varname></term>
> +
> +        <listitem><para>SSL CA certificate in PEM format.</para></listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>TrustedCertificateFile=</varname></term>
> +
> +        <listitem><para>SSL CA certificate.</para></listitem>
> +      </varlistentry>
> +
> +    </variablelist>

A bit short, but better than nothing, so I wouldn't mind applying it.
Maybe Zbigniew can amend some more information.

> +
> +  </refsect1>
> +
> +  <refsect1>
> +      <title>See Also</title>
> +      <para>
> +        <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>

I'd add some more entries here, including systemd(1) and systemd-journald(1).

Otherwise looks good. I'll leave this to Zbigniew, though. I have not
much clue of how journal-remote works, sorry!

Thanks
David

> +      </para>
> +  </refsect1>
> +
> +</refentry>
> diff --git a/man/systemd-journal-remote.xml b/man/systemd-journal-remote.xml
> index 2687662..d5bda63 100644
> --- a/man/systemd-journal-remote.xml
> +++ b/man/systemd-journal-remote.xml
> @@ -310,6 +310,7 @@ systemd-journal-remote --url http://some.host:19531/
>        <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
>        <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
>        <citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
> +      <citerefentry><refentrytitle>journal-remote.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
>      </para>
>    </refsect1>
>  </refentry>
> --
> 2.1.0
>
> _______________________________________________
> systemd-devel mailing list
> systemd-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/systemd-devel