[systemd-devel] [PATCH 11/12] Add man page and references to it.

[Didier Roche]

Le 28/01/2015 16:06, Zbigniew Jędrzejewski-Szmek a écrit :
> On Wed, Jan 28, 2015 at 02:24:55PM +0100, Didier Roche wrote:
>>  From 6b13d8fb248bf4176f1ad7e1d4736683462bf196 Mon Sep 17 00:00:00 2001
>> From: Didier Roche <didrocks at ubuntu.com>
>> Date: Mon, 26 Jan 2015 17:34:59 +0100
>> Subject: [PATCH 11/12] Add man page and references to it.
>> --- /dev/null
>> +++ b/man/systemd-fsckd.service.xml
>> @@ -0,0 +1,170 @@
>> +<?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 Canonical
>> +
>> +  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="systemd-fsckd.service" xmlns:xi="http://www.w3.org/2001/XInclude">
> Please use 2ch indentation for new man pages.

Converted to 2 characters for indentation.
>
>> +                progress, and communicating some consolidated data
>> +                to console and plymouth (if running). It also handles
>> +                possible check cancellations.</para>
>> +                <para><filename>systemd-fsck-root.service</filename> or
>> +                <filename>systemd-fsck at .service</filename> will get the
>> +                progress from fsck and send their individual progress to
>> +                <filename>systemd-fsckd</filename>, through socket activation
>> +                by <filename>systemd-fsckd.socket</filename>.</para>
> I think we don't need this kind of detail in the man page. It might change anyway.
Removed then!
>> +                <para>Progress update, sent as a plymouth update message:
>> +                   <literal>fsckd:<num_devices>:<progress>:<string></literal>
>> +                   <variablelist>
>> +                      <varlistentry>
>> +                         <term><literal><num_devices></literal></term>
>> +                         <listitem><para>the current number of devices
>> +                         being checked (int)</para></listitem>
>> +                      </varlistentry>
>> +                      <varlistentry>
>> +                         <term><literal><progress></literal></term>
>> +                         <listitem><para>the current minimum percentage of
>> +                         all devices being checking (float, from 0 to 100)</para></listitem>
>> +                      </varlistentry>
>> +                      <varlistentry>
>> +                         <term><literal><string></literal></term>
>> +                         <listitem><para>a translated message ready to be displayed
>> +                         by the plymouth theme displaying the data above. It can be overriden
>> +                         by themes supporting i18n.</para></listitem>
>> +                      </varlistentry>
>> +                   </variablelist>
>> +                </para>
>> +
>> +                <para>Cancel message, sent as a traditional plymouth message:
>> +                   <literal>fsckd-cancel-msg:<string></literal>
>> +                   <variablelist>
>> +                      <varlistentry>
>> +                         <term><literal><strings></literal></term>
>> +                         <listitem><para>a translated string ready to be displayed
>> +                         by the plymouth theme indicating that c or C can be used to cancel
>> +                         current checks. It can be overriden (matching only
>> +                         <literal>fsckd-cancel-msg</literal> prefix)
>> +                         by themes supporting i18n.</para></listitem>
>> +                      </varlistentry>
>> +                   </variablelist>
>> +                </para>
> This is very detailed too, but it is OK, we don't really have a good place for this
> kind of documentation.


Yeah, some API for plymouth theme authors. I didn't find a better place 
(or the systemd wiki?)

Thanks again for the detailed rereading :)
Cheers,
Didier