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

2015-01-30 Thread Zbigniew Jędrzejewski-Szmek 
On Thu, Jan 29, 2015 at 06:46:40PM +0100, Didier Roche wrote:
> >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?)

The wiki tends to get outdated... This text is not too long and it'll
be easier to find and maintain here.

Zbyszek
___
systemd-devel mailing list
systemd-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/systemd-devel

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

2015-01-29 Thread 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 
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 @@
+
+
+http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+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.
+systemd-fsck-root.service or
+systemd-fsck@.service will get the
+progress from fsck and send their individual progress to
+systemd-fsckd, through socket activation
+by systemd-fsckd.socket.

I think we don't need this kind of detail in the man page. It might change 
anyway.

Removed then!

+Progress update, sent as a plymouth update message:
+   
fsckd:::
+   
+  
+ 
+ the current number of devices
+ being checked (int)
+  
+  
+ 
+ the current minimum percentage of
+ all devices being checking (float, from 0 to 
100)
+  
+  
+ 
+ a translated message ready to be 
displayed
+ by the plymouth theme displaying the data above. It 
can be overriden
+ by themes supporting i18n.
+  
+   
+
+
+Cancel message, sent as a traditional plymouth message:
+   fsckd-cancel-msg:
+   
+  
+ 
+ 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
+ fsckd-cancel-msg prefix)
+ by themes supporting i18n.
+  
+   
+

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
___
systemd-devel mailing list
systemd-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/systemd-devel

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

2015-01-28 Thread Zbigniew Jędrzejewski-Szmek 
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 
> Date: Mon, 26 Jan 2015 17:34:59 +0100
> Subject: [PATCH 11/12] Add man page and references to it.
> 
> Add man page explaining the plymouth theme protocol, usage of the daemon
> as well as the socket activation part.
> Adapt existing fsck man page.
> ---
>  Makefile-man.am|  12 +++
>  man/systemd-f...@.service.xml  |   6 +-
>  man/systemd-fsckd.service.xml  | 170 
> +
>  units/systemd-fsckd.service.in |   1 +
>  units/systemd-fsckd.socket |   2 +-
>  5 files changed, 188 insertions(+), 3 deletions(-)
>  create mode 100644 man/systemd-fsckd.service.xml
> 
> diff --git a/Makefile-man.am b/Makefile-man.am
> index 105853e..f2e13e8 100644
> --- a/Makefile-man.am
> +++ b/Makefile-man.am
> @@ -67,6 +67,7 @@ MANPAGES += \
>   man/systemd-escape.1 \
>   man/systemd-firstboot.1 \
>   man/systemd-fsck@.service.8 \
> + man/systemd-fsckd.service.8 \
>   man/systemd-fstab-generator.8 \
>   man/systemd-getty-generator.8 \
>   man/systemd-gpt-auto-generator.8 \
> @@ -210,6 +211,8 @@ MANPAGES_ALIAS += \
>   man/systemd-firstboot.service.1 \
>   man/systemd-fsck-root.service.8 \
>   man/systemd-fsck.8 \
> + man/systemd-fsckd.8 \
> + man/systemd-fsckd.socket.8 \
>   man/systemd-hibernate-resume.8 \
>   man/systemd-hibernate.service.8 \
>   man/systemd-hybrid-sleep.service.8 \
> @@ -323,6 +326,8 @@ man/systemd-ask-password-wall.service.8: 
> man/systemd-ask-password-console.servic
>  man/systemd-firstboot.service.1: man/systemd-firstboot.1
>  man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8
>  man/systemd-fsck.8: man/systemd-fsck@.service.8
> +man/systemd-fsckd.8: man/systemd-fsckd.service.8
> +man/systemd-fsckd.socket.8: man/systemd-fsckd.service.8
>  man/systemd-hibernate-resume.8: man/systemd-hibernate-resume@.service.8
>  man/systemd-hibernate.service.8: man/systemd-suspend.service.8
>  man/systemd-hybrid-sleep.service.8: man/systemd-suspend.service.8
> @@ -606,6 +611,12 @@ man/systemd-fsck-root.service.html: 
> man/systemd-f...@.service.html
>  man/systemd-fsck.html: man/systemd-f...@.service.html
>   $(html-alias)
>  
> +man/systemd-fsckd.html: man/systemd-fsckd.service.html
> + $(html-alias)
> +
> +man/systemd-fsckd.socket.html: man/systemd-fsckd.service.html
> + $(html-alias)
> +
>  man/systemd-hibernate-resume.html: man/systemd-hibernate-res...@.service.html
>   $(html-alias)
>  
> @@ -1732,6 +1743,7 @@ EXTRA_DIST += \
>   man/systemd-escape.xml \
>   man/systemd-firstboot.xml \
>   man/systemd-f...@.service.xml \
> + man/systemd-fsckd.service.xml \
>   man/systemd-fstab-generator.xml \
>   man/systemd-getty-generator.xml \
>   man/systemd-gpt-auto-generator.xml \
> diff --git a/man/systemd-f...@.service.xml b/man/systemd-f...@.service.xml
> index ee66f37..d366712 100644
> --- a/man/systemd-f...@.service.xml
> +++ b/man/systemd-f...@.service.xml
> @@ -87,8 +87,9 @@
>  check, number of mounts, unclean unmount, etc.
>  
>  systemd-fsck will forward
> -file system checking progress to the console. If a
> -file system check fails for a service without
> +file system checking progress to
> +systemd-fsckd.service
> +socket. If a file system check fails for a service without
>  nofail, emergency mode is activated,
>  by isolating to
>  emergency.target.
> @@ -142,6 +143,7 @@
>  
>  
> systemd1,
>  
> fsck8,
> +
> systemd-fsckd.service8,
>  
> systemd-quotacheck.service8,
>  
> fsck.btrfs8,
>  
> fsck.cramfs8,
> diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml
> new file mode 100644
> index 000..befcc45
> --- /dev/null
> +++ b/man/systemd-fsckd.service.xml
> @@ -0,0 +1,170 @@
> +
> +
> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
> +
> + xmlns:xi="http://www.w3.org/2001/XInclude";>
Please use 2ch indentation for new man pages.

> +
> +
> +systemd-fsckd.service
> +systemd
> +
> +
> +
> +Developer
> +Didier
> +Roche
> +didro...@ubuntu.com
> +
> +
> +
> +
> +
> +systemd-fsckd.service
> +8
> +
> +
> +
> +systemd-fsckd.service
> +systemd-fsckd.socket
> +systemd-fsckd
> +

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

2015-01-28 Thread Didier Roche 


>From 6b13d8fb248bf4176f1ad7e1d4736683462bf196 Mon Sep 17 00:00:00 2001
From: Didier Roche 
Date: Mon, 26 Jan 2015 17:34:59 +0100
Subject: [PATCH 11/12] Add man page and references to it.

Add man page explaining the plymouth theme protocol, usage of the daemon
as well as the socket activation part.
Adapt existing fsck man page.
---
 Makefile-man.am|  12 +++
 man/systemd-f...@.service.xml  |   6 +-
 man/systemd-fsckd.service.xml  | 170 +
 units/systemd-fsckd.service.in |   1 +
 units/systemd-fsckd.socket |   2 +-
 5 files changed, 188 insertions(+), 3 deletions(-)
 create mode 100644 man/systemd-fsckd.service.xml

diff --git a/Makefile-man.am b/Makefile-man.am
index 105853e..f2e13e8 100644
--- a/Makefile-man.am
+++ b/Makefile-man.am
@@ -67,6 +67,7 @@ MANPAGES += \
 	man/systemd-escape.1 \
 	man/systemd-firstboot.1 \
 	man/systemd-fsck@.service.8 \
+	man/systemd-fsckd.service.8 \
 	man/systemd-fstab-generator.8 \
 	man/systemd-getty-generator.8 \
 	man/systemd-gpt-auto-generator.8 \
@@ -210,6 +211,8 @@ MANPAGES_ALIAS += \
 	man/systemd-firstboot.service.1 \
 	man/systemd-fsck-root.service.8 \
 	man/systemd-fsck.8 \
+	man/systemd-fsckd.8 \
+	man/systemd-fsckd.socket.8 \
 	man/systemd-hibernate-resume.8 \
 	man/systemd-hibernate.service.8 \
 	man/systemd-hybrid-sleep.service.8 \
@@ -323,6 +326,8 @@ man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.servic
 man/systemd-firstboot.service.1: man/systemd-firstboot.1
 man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8
 man/systemd-fsck.8: man/systemd-fsck@.service.8
+man/systemd-fsckd.8: man/systemd-fsckd.service.8
+man/systemd-fsckd.socket.8: man/systemd-fsckd.service.8
 man/systemd-hibernate-resume.8: man/systemd-hibernate-resume@.service.8
 man/systemd-hibernate.service.8: man/systemd-suspend.service.8
 man/systemd-hybrid-sleep.service.8: man/systemd-suspend.service.8
@@ -606,6 +611,12 @@ man/systemd-fsck-root.service.html: man/systemd-f...@.service.html
 man/systemd-fsck.html: man/systemd-f...@.service.html
 	$(html-alias)
 
+man/systemd-fsckd.html: man/systemd-fsckd.service.html
+	$(html-alias)
+
+man/systemd-fsckd.socket.html: man/systemd-fsckd.service.html
+	$(html-alias)
+
 man/systemd-hibernate-resume.html: man/systemd-hibernate-res...@.service.html
 	$(html-alias)
 
@@ -1732,6 +1743,7 @@ EXTRA_DIST += \
 	man/systemd-escape.xml \
 	man/systemd-firstboot.xml \
 	man/systemd-f...@.service.xml \
+	man/systemd-fsckd.service.xml \
 	man/systemd-fstab-generator.xml \
 	man/systemd-getty-generator.xml \
 	man/systemd-gpt-auto-generator.xml \
diff --git a/man/systemd-f...@.service.xml b/man/systemd-f...@.service.xml
index ee66f37..d366712 100644
--- a/man/systemd-f...@.service.xml
+++ b/man/systemd-f...@.service.xml
@@ -87,8 +87,9 @@
 check, number of mounts, unclean unmount, etc.
 
 systemd-fsck will forward
-file system checking progress to the console. If a
-file system check fails for a service without
+file system checking progress to
+systemd-fsckd.service
+socket. If a file system check fails for a service without
 nofail, emergency mode is activated,
 by isolating to
 emergency.target.
@@ -142,6 +143,7 @@
 
 systemd1,
 fsck8,
+systemd-fsckd.service8,
 systemd-quotacheck.service8,
 fsck.btrfs8,
 fsck.cramfs8,
diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml
new file mode 100644
index 000..befcc45
--- /dev/null
+++ b/man/systemd-fsckd.service.xml
@@ -0,0 +1,170 @@
+
+
+http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+http://www.w3.org/2001/XInclude";>
+
+
+systemd-fsckd.service
+systemd
+
+
+
+Developer
+Didier
+Roche
+didro...@ubuntu.com
+
+
+
+
+
+systemd-fsckd.service
+8
+
+
+
+systemd-fsckd.service
+systemd-fsckd.socket
+systemd-fsckd
+File system check progress reporting
+
+
+
+systemd-fsckd.service
+systemd-fsckd.socket
+/usr/lib/systemd/systemd-fsckd
+
+
+
+Description
+
+systemd-fsckd.service is a
+service responsible for fetching file system check
+progress, and communicating some consolidated data
+to console and plymouth (if running). It also handles
+poss