[git commit] Improve examples/var_service READMEs

Denys Vlasenko vda.linux at googlemail.com
Fri Feb 21 11:55:43 UTC 2014


commit: http://git.busybox.net/busybox/commit/?id=192c14bd87aa2ea930bc4a3954a07c1cab46a3cc
branch: http://git.busybox.net/busybox/commit/?id=refs/heads/master

Signed-off-by: Denys Vlasenko <vda.linux at googlemail.com>
---
 examples/var_service/README                |   13 +++++++++++--
 examples/var_service/dhcp_if/README        |    5 +++++
 examples/var_service/dhcp_if_pinger/README |    5 +++++
 examples/var_service/ftpd/README           |    5 +++++
 examples/var_service/fw/README             |    5 +++++
 examples/var_service/getty_tty1/README     |    5 +++++
 examples/var_service/gpm/README            |    5 +++++
 examples/var_service/httpd/README          |    5 +++++
 examples/var_service/ifplugd_if/README     |    5 +++++
 examples/var_service/inetd/README          |    5 +++++
 examples/var_service/nmeter/README         |    5 +++++
 examples/var_service/ntpd/README           |    5 +++++
 examples/var_service/tftpd/README          |    5 +++++
 13 files changed, 71 insertions(+), 2 deletions(-)

diff --git a/examples/var_service/README b/examples/var_service/README
index 06817c8..9ad1b25 100644
--- a/examples/var_service/README
+++ b/examples/var_service/README
@@ -9,6 +9,15 @@ env - PATH=... <other vars=...> runsvdir /var/service &
 from one of system startup scripts. (Google "man runsvdir" and "man runsv"
 for more info about these tools).
 
+You can try or debug an individual service by running its SERVICE_DIR/run script.
+In this case, its stdout and stderr go to your terminal.
+
+You can also run "runsv SERVICE_DIR", which runs both the service
+and its logger service (SERVICE_DIR/log/run) if logger service exists.
+If logger service exists, the output will go to it instead of the terminal.
+
+"runsvdir DIR" merely runs "runsv SERVICE_DIR" for every subdirectory in DIR.
+
 Some existing examples:
 
 var_service/dhcp_if -
@@ -47,8 +56,8 @@ This even works while fw service runs: if dhcp signals fw to (re)start
 while fw runs, fw will not stop after its execution, but will re-execute once,
 picking up dhcp's new configuration.
 This is achieved very simply by having
-# Make ourself one-shot
-sv o .
+	# Make ourself one-shot
+	sv o .
 at the very beginning of fw/run script, not at the end.
 Therefore, any "sv u /var/run/service/fw" command by any other
 script "undoes" o(ne-shot) command if fw still runs, thus
diff --git a/examples/var_service/dhcp_if/README b/examples/var_service/dhcp_if/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/dhcp_if/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/dhcp_if_pinger/README b/examples/var_service/dhcp_if_pinger/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/dhcp_if_pinger/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/ftpd/README b/examples/var_service/ftpd/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/ftpd/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/fw/README b/examples/var_service/fw/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/fw/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/getty_tty1/README b/examples/var_service/getty_tty1/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/getty_tty1/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/gpm/README b/examples/var_service/gpm/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/gpm/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/httpd/README b/examples/var_service/httpd/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/httpd/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/ifplugd_if/README b/examples/var_service/ifplugd_if/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/ifplugd_if/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/inetd/README b/examples/var_service/inetd/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/inetd/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/nmeter/README b/examples/var_service/nmeter/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/nmeter/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/ntpd/README b/examples/var_service/ntpd/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/ntpd/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.
diff --git a/examples/var_service/tftpd/README b/examples/var_service/tftpd/README
new file mode 100644
index 0000000..4ddccb2
--- /dev/null
+++ b/examples/var_service/tftpd/README
@@ -0,0 +1,5 @@
+The real README file is one directory up.
+
+This directory's run script can have useful comments.
+If it doesn't but you feel it should, please send a patch
+to busybox's mailing list.


More information about the busybox-cvs mailing list