Your message dated Sun, 03 Feb 2019 23:49:37 +0000
with message-id <e1gqrw5-000gfi...@fasolo.debian.org>
and subject line Bug#920963: fixed in dh-runit 2.8.4
has caused the Debian Bug report #920963,
regarding dh-runit: copy-edits to dh_runit(1) manpage
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact ow...@bugs.debian.org
immediately.)
--
920963: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=920963
Debian Bug Tracking System
Contact ow...@bugs.debian.org with problems
--- Begin Message ---
Package: dh-runit
Version: 2.8.3
Severity: minor
Justification: documentation
Reading the dh_runit(1) manpage, I ran into a few small nits that
made it harder to read. Mostly:
- some missing or extra articles ("a" or "the")
- F<> markup showing up in list items
- some word usage nits (e.g. "different" meaning "various" and so on)
A patch follows with some suggested edits. I'm happy to explain any
details that seem unclear and I won't be hurt if you clear up the text
in a different way. I'm cc-ing debian-l10n-english since they tend to
be very good at this kind of editing for readability.
debian-l10n-english: you can find the source file in dh_runit in
https://salsa.debian.org/runit-team/dh-runit.git, and you can preview
the output by running "perldoc ./dh_runit".
Thoughts of all kinds welcome, as always.
diff --git a/debian/changelog b/debian/changelog
index 5facc36..431b3e7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+dh-runit (2.8.4) UNRELEASED; urgency=medium
+
+ * Copy-edit dh_runit(1) documentation.
+
+ -- Jonathan Nieder <jrnie...@gmail.com> Wed, 30 Jan 2019 15:44:58 -0800
+
dh-runit (2.8.3) unstable; urgency=medium
* Document runit:Breaks substitution variable
diff --git a/dh_runit b/dh_runit
index 447ae70..7baad5f 100755
--- a/dh_runit
+++ b/dh_runit
@@ -122,77 +122,80 @@ B<dh_runit> [S<I<debhelper options>>] [I<path>
I<options>] ...
=head1 DESCRIPTION
B<dh_runit> is a debhelper program that is responsible for
-installing and enabling I<runit> runscripts. If file named
-F<debian/I<package>.runit> exists, then different actions
-are performed, depending on its format.
+installing and enabling I<runit> runscripts. If a file named
+F<debian/I<package>.runit> exists, then it ensures appropriate actions
+are performed based on its content.
-For runit, every unit of supervision, simply speaking program, is
-represented by directory under F</etc/sv>, containing at least F<run>
-executable file. Every enabled program is represented by symbolic link
-under F</etc/services> (which itself is symbolic link to
+For runit, each unit of supervision (or, simply speaking, program) is
+represented by a directory under F</etc/sv>, containing at least a F<run>
+executable file. Each enabled unit of supervision is represented by a
+symbolic link under F</etc/services> (which itself is a symbolic link to
F</etc/runit/runsvdir/default>) pointing to some directory under
F</etc/sv>.
-B<dh_runit> reads it's arguments from command line and
-F<debian/I<package>.runit> by two, with first one being an
-file/directory and second one is options. If first argument is file,
-it is considered 'run' script, and it is installed under
-F</etc/sv/*/run>, executable bit is added. If first argument is
-directory, it is copied as whole under F</etc/sv>.
+B<dh_runit> reads arguments from the command line and
+F<debian/I<package>.runit> in pairs, with the first item being the
+path to a file or directory and the second being a set of options.
+If the first argument names a file, it is treated as a 'run' script
+to be installed at F</etc/sv/*/run> as an executable file. If the first
+argument names a directory, that directory is copied as a whole to
+F</etc/sv>.
-Options are comma-separated, like to mount. Unsupported option
-is error, following are supported:
+Options are comma separated, like mount options. Unrecognized options
+are errors. The following options are recognized:
=over
=item I<disable>
- With this option, runscript is installed, but not enabled by
- default. It means that corresponding service will not be started.
- System administrator can always do it manually or via
- update-service(8).
+Install the runscript but do not enable it by default.
+This means that the corresponding service will not be started.
+The service can be enabled manually by the system administrator or
+automatically using update-service(8).
=item I<name>=preferred-name
- By default, name of directory under F</etc/sv> for given runscript
- is basename of first argument of pair. This option allows you to
- be explicit about it.
+By default, the name of the directory under F</etc/sv> for a given
+runscript is the basename of the path argument naming it. This
+option allows overriding that default with an explicitly chosen
+directory name.
=item I<logscript>
- Install standard F<log/run> script, which invokes svlogd(8) with
- rights of dedicated user. It is error, if first argument in pair
- is directory, which already contains F</log/run> script.
+Install a standard F<log/run> script that invokes svlogd(8) with
+the rights of the dedicated user. Specifying this option produces
+an error if the path argument names a directory that already
+contains a F</log/run> script.
=item I<defaults>
- If you need no other options, put this one.
+If you don't need other options, specify this one.
=back
=head1 SUBSTITUTION VARIABLES
-Package, created with help of B<dh_runit> does not depends on B<runit>,
-but should add I<runit:Breaks> variable into I<Breaks> field in
I<debian/control>
-to ensure, that no breakages are caused by too old version of B<runit> package.
+Packages using B<dh_runit> do not depend on B<runit> but should include the
+I<runit:Breaks> variable in their I<Breaks> field in I<debian/control>
+to ensure that no breakages are caused by a too-old version of B<runit>
package.
=head1 EXAMPLES
-This section contains several example snippets from F<I<package>.runit>
+This section contains several example F<I<package>.runit> snippets.
- # In this case file is installed as 'run' script. Directory name under
- # /etc/sv is derived from file basename
+ # In this case, a file is installed as a 'run' script. The directory
+ # name under /etc/sv is derived from the file's basename (/etc/sv/script).
path/to/file/to/be/installed/as/run/script defaults
- # Same, but install directory as whole. It is your responsibility
- # to ensure is contains everything required.
+ # Similar, but installs a directory as a whole. It is the package's
+ # responsibility to ensure this directory contains everything required.
path/to/directory defaults
- # Same as above, but do not create symlink under /etc/service
+ # Similar, but without creating a symlink under /etc/service.
path/to/directory disable
- # You can explicitly specify name of directory under /etc/sv.
- # Standard log/run script will be created.
+ # Explicitly specifying a name to use for the directory under /etc/sv.
+ # A standard log/run script will be created.
path/to/directory name=my-preferred-name,logscript
=cut
--- End Message ---
--- Begin Message ---
Source: dh-runit
Source-Version: 2.8.4
We believe that the bug you reported is fixed in the latest version of
dh-runit, which is due to be installed in the Debian FTP archive.
A summary of the changes between this version and the previous one is
attached.
Thank you for reporting the bug, which will now be closed. If you
have further comments please address them to 920...@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Dmitry Bogatov <kact...@debian.org> (supplier of updated dh-runit package)
(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmas...@ftp-master.debian.org)
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512
Format: 1.8
Date: Sun, 03 Feb 2019 23:19:55 +0000
Source: dh-runit
Binary: dh-runit runit-helper
Architecture: source
Version: 2.8.4
Distribution: unstable
Urgency: medium
Maintainer: Dmitry Bogatov <kact...@debian.org>
Changed-By: Dmitry Bogatov <kact...@debian.org>
Description:
dh-runit - debhelper add-on to handle runit runscripts
runit-helper - dh-sysuser implementation detail
Closes: 920963
Changes:
dh-runit (2.8.4) unstable; urgency=medium
.
* Copy-edit dh_runit(1) documentation. (Closes: #920963)
+ Thanks: Jonathan Nieder <jrnie...@gmail.com>
Checksums-Sha1:
9edb39d44ab9b2beb551b952d243e68de38cff7e 1671 dh-runit_2.8.4.dsc
62622d49ebc2e5a2fcaa30c5f9c481a52b6cc132 6812 dh-runit_2.8.4.tar.xz
12ad0ecdfc3ce4f10f6a7e653383b7a3124865c0 5435 dh-runit_2.8.4_source.buildinfo
Checksums-Sha256:
157a42e57d8aa8df8066ceaf82c13011ce977f8e157b6d3eed7daa1dafe16eeb 1671
dh-runit_2.8.4.dsc
a9b9a58468cbb58c19d9f75fb66aab3f8597a518f41de6e22f420616b352a16d 6812
dh-runit_2.8.4.tar.xz
2330df038ba6336c0ed06336df8539c66fb539a3be2571a7c998381ecf5da685 5435
dh-runit_2.8.4_source.buildinfo
Files:
6b9db8dbabb7976c1fb755c30c8a713b 1671 admin optional dh-runit_2.8.4.dsc
791bdd17c0a0bf0119dc84256b607ff1 6812 admin optional dh-runit_2.8.4.tar.xz
7ac07abd86298bc3c1ae6f52a73ad9bb 5435 admin optional
dh-runit_2.8.4_source.buildinfo
-----BEGIN PGP SIGNATURE-----
iQJHBAEBCgAxFiEEhnHVzDbtdH7ktKj4SBLY3qgmEeYFAlxXd3ITHGthY3Rpb25A
ZGViaWFuLm9yZwAKCRBIEtjeqCYR5qYWD/0XR4QS/WjG+IxXPG5+yNHv2I6ggFu0
cM/h0k7Z6/+e3DVU90OHc311SyTS0HumQWEPUiA/q2fB3sGkOiX2BpBK1Q/UKdKf
sIju/Fddk81527z7iLcLpzYUwjZPxkEQehiD8qvGbhWCWy3wLStnef/4NOgE4P7J
GPODR/jjSz/2HZw/V3vEMPyJ1XN3ppyrmZXQ/b3kYEoEkWi4Pvjlr/Q1RbStKHdL
f36fD+evhO06DDEYjef8hxdFN6OrQ0pe5IqBPEEqXcSekjfcImaxe8S2S4HVkJeD
hOjR0WUzEpeIkbytuBUAlanRz70/8iy9KsvoQo363vt9bUQDb267eTDED8CHRuq5
JXr2FCDgHX24ki+EuDFbDu0Z4kiYdpwg0QlWRC5iuu5GaCrffSuhThk4uN6IB6fD
1rndH6DubsPEbQjvWopU/h7uc78fGDIWNryyIorRTklUMaa/7mOhnK3UboGeXVDR
jzGLr7fxFRrJgVY23cmhiRk6IH77JYXJ780czDeO5cIfI3RWkefeP9E3ilNoI/Yy
+hsSHeNWwdB42SNgod9Ppbu8Iscxo8ctqDH4ncB/XqSFo3S4JdYI+eWSozhByQof
ZPgm0S8oxf/2LUb8csVMERn8v1jvXxEZtwnfQ0Wms3JLfSZRrfhJLDNgF3RrO1d/
K5x7vbpnimjlrQ==
=uzeX
-----END PGP SIGNATURE-----
--- End Message ---
