[Openstack-devel] Bug#694518: [RFR] templates://sheepdog/{sheepdog.templates}

Justin B Rye jbr at edlug.org.uk
Sat Dec 1 16:40:56 UTC 2012


Christian PERRIER wrote:
> Template: sheepdog/start
> Type: boolean
> Default: true
> _Description: Automatically start the sheepdog service?
>  Please choose whether you want the shhepdog service to
>  start automatically when the system is booted.

Typo: s/shhep/sheep/.  And no need to phrase it as a decision about
what I want -

    Please choose whether the sheepdog service should start automatically
    when the system is booted.
 
> Template: sheepdog/daemon_args
> Type: string
> Default: 
> _Description: Arguments for the sheepdog daemon:
>  If no argument is given, the sheepdog daemon is started with the corosync driver on
>  port 7000.

Shouldn't this start with something like:

   Please choose the commandline arguments that should be passed to the
   sheepdog daemon. If no argument is given, the default behavior is to
   start with the corosync driver on port 7000.

(Does that mean "with 7000 as the corosync driver port" or is it two
things, "start on port 7000, using the corosync driver"?  Or will
sheepdog users find it obvious?)

>  .
>  Addition arguments are:

As MES spotted, s/Addition/Additional/, but "additional" to what?

   Available options include:

>    -p, --port              specify the TCP port to listen to
>    -l, --loglevel          specify the level of logging detail
>    -d, --debug             include debug messages in the log
>    -D, --directio          use direct I/O when accessing the object store
>    -z, --zone              specify the zone ID
>    -c, --cluster           specify the cluster driver
>  More infomation can be found in the sheep(8) manual page.
            ^
s/fom/form/.  I suppose it doesn't matter that we could do all this
with a one-column indent and less of a gap.  I was surprised to learn
that the controlling daemon is called "sheep", though...

The package description is really quite good:

> -Description: Distributed storage system for KVM/QEMU
> +Description: distributed storage system for KVM/QEMU
>   Sheepdog provides highly available block level storage volumes that can be
>   attached to KVM/QEMU virtual machines. Sheepdog scales to several hundreds
                                                                             ^
>   nodes, and supports advanced volume management features such as snapshot,
>   cloning, and thin provisioning.

"Highly available" isn't something I'd naturally say, but people who
care about this topic seem to, so fair enough.  It's possible this
use of "snapshot" to mean "snapshotting"/"snapshot capability" is a
similar piece of jargon, but I'd prefer to avoid it by recycling that
surplus S from the line before:

    Sheepdog provides highly available block level storage volumes that can be
    attached to KVM/QEMU virtual machines. Sheepdog scales to several hundred
    nodes, and supports advanced volume management features such as snapshots,
    cloning, and thin provisioning.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru sheepdog-0.5.4.pristine/debian/control sheepdog-0.5.4/debian/control
--- sheepdog-0.5.4.pristine/debian/control	2012-11-25 14:52:16.000000000 +0000
+++ sheepdog-0.5.4/debian/control	2012-12-01 16:35:43.042724427 +0000
@@ -20,8 +20,8 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Recommends: corosync
-Description: Distributed storage system for KVM/QEMU
+Description: distributed storage system for KVM/QEMU
  Sheepdog provides highly available block level storage volumes that can be
- attached to KVM/QEMU virtual machines. Sheepdog scales to several hundreds
- nodes, and supports advanced volume management features such as snapshot,
+ attached to KVM/QEMU virtual machines. Sheepdog scales to several hundred
+ nodes, and supports advanced volume management features such as snapshots,
  cloning, and thin provisioning.
diff -ru sheepdog-0.5.4.pristine/debian/sheepdog.templates sheepdog-0.5.4/debian/sheepdog.templates
--- sheepdog-0.5.4.pristine/debian/sheepdog.templates	2012-10-24 07:52:54.000000000 +0100
+++ sheepdog-0.5.4/debian/sheepdog.templates	2012-12-01 16:38:21.131057245 +0000
@@ -1,22 +1,23 @@
 Template: sheepdog/start
 Type: boolean
 Default: true
-_Description: Automatic start sheepdog service?
- You can set this to false to make sheepdog service doesn't
- start automaticly if you need.
+_Description: Automatically start the sheepdog service?
+ Please choose whether the sheepdog service should start automatically
+ when the system is booted.
 
 Template: sheepdog/daemon_args
 Type: string
 Default: 
-_Description: The arguments passed when start service:
- The default behavior with no argument is start with corosync driver on
- port 7000.
+_Description: Arguments for the sheepdog daemon:
+ Please choose the commandline arguments that should be passed to the
+ sheepdog daemon. If no argument is given, the default behavior is to
+ start with the corosync driver on port 7000.
  .
- The options can be used include:
-   -p, --port              specify the TCP port on which to listen
+ Available options include:
+   -p, --port              specify the TCP port to listen to
    -l, --loglevel          specify the level of logging detail
    -d, --debug             include debug messages in the log
-   -D, --directio          use direct IO when accessing the object store
-   -z, --zone              specify the zone id
+   -D, --directio          use direct I/O when accessing the object store
+   -z, --zone              specify the zone ID
    -c, --cluster           specify the cluster driver
- More infomation can be found in sheep(8).
+ More information can be found in the sheep(8) manual page.
-------------- next part --------------
Template: sheepdog/start
Type: boolean
Default: true
_Description: Automatically start the sheepdog service?
 Please choose whether the sheepdog service should start automatically
 when the system is booted.

Template: sheepdog/daemon_args
Type: string
Default: 
_Description: Arguments for the sheepdog daemon:
 Please choose the commandline arguments that should be passed to the
 sheepdog daemon. If no argument is given, the default behavior is to
 start with the corosync driver on port 7000.
 .
 Available options include:
   -p, --port              specify the TCP port to listen to
   -l, --loglevel          specify the level of logging detail
   -d, --debug             include debug messages in the log
   -D, --directio          use direct I/O when accessing the object store
   -z, --zone              specify the zone ID
   -c, --cluster           specify the cluster driver
 More information can be found in the sheep(8) manual page.
-------------- next part --------------
Source: sheepdog
Section: admin
Priority: optional
Maintainer: PKG OpenStack <openstack-devel at lists.alioth.debian.org>
Uploaders: YunQiang Su <wzssyqa at gmail.com>, Guido Guenther <agx at debian.org>
Build-Depends: debhelper (>= 7.0.50~),
 dh-autoreconf,
 bash-completion,
 pkg-config,
 libcorosync-dev,
 liburcu-dev,
 libzookeeper-mt-dev [linux-any],
 po-debconf
Standards-Version: 3.9.4.0
Homepage: http://www.osrg.net/sheepdog/
Vcs-Browser: http://git.debian.org/?p=openstack/sheepdog.git
Vcs-Git: git://git.debian.org/openstack/sheepdog.git

Package: sheepdog
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Recommends: corosync
Description: distributed storage system for KVM/QEMU
 Sheepdog provides highly available block level storage volumes that can be
 attached to KVM/QEMU virtual machines. Sheepdog scales to several hundred
 nodes, and supports advanced volume management features such as snapshots,
 cloning, and thin provisioning.


More information about the Openstack-devel mailing list