Re: [RFR] templates://nbd/{nbd-client.templates,nbd-server.templates}
> Template: nbd-client/no-auto-config
> Type: error
> +_Description: AUTO_GEN is set at "n" in /etc/nbd-client
Is that "variable FOO is set at value BAR"? Unless it's a scale of
"a" to "z", I'd say "set to" (as indeed in the following text).
Likewise for nbd-server/autogen.
> Template: nbd-client/type
[...]
> +_Description: Use of network block device number ${number}:
Just to make sure nobody's misled into reading that as the verb
("uze") rather than the noun ("uce"), say:
_Description: Intended use of network block device number ${number}:
> Template: nbd-client/device
[...]
> If an unexisting /dev entry is provided, it will be created with minor
> + number ${number}.
An inexistiant word; but you don't quite want plain "nonexistent".
"Non-preexisting" would cover it, but really:
If the /dev entry specified does not exist, it will be created with minor
number ${number}.
> Template: nbd-client/killall
[...]
> _Description: Kill all nbd devices on 'stop'?
"Killing" a device suggests smashing the hardware; as far as I can
see there's not even any use of kill or killall here, just umount.
Also, s/nbd/NBD/.
> When the nbd-client initscript is called to stop the nbd-client
> service, there are two things that can be done: either it can stop all
> nbd-client devices, or it can stop only those nbd-client devices that
> it knows about in its config file.
That's okay, but I don't like the next paragraph:
> The traditional behaviour was to stop all nbd-client devices, including
> those that were not specified in the nbd-client config file; for that
> reason, the default answer is to kill all nbd devices. However, if you
> + are running critical file systems, such as the root device, on NBD,
> then this is a bad idea; in that case, please do not accept this
> option.
s/behaviour/behavior/; but why the past tense if it's still the
default? And reduce the repetition:
_Description: Unmount all NBD devices on "stop"?
[...]
The traditional behavior is to unmount all nbd-client devices, but this
default should not be accepted if the root device or other critical file
systems are on NBD.
> Template: nbd-server/number
[...]
> +_Description: Number of nbd-server instances to run :
^
Perforated colon. Oh, in fact it's a Latin-1 non-breaking space!
> Template: nbd-server/filename
[...]
> +_Description: File to export sy server number ${number}):
Mismatched brackets, and "sy"... did you mean this?
_Description: File to export (server number ${number}):
> + Please specify a file name or block device you want to export
> + over the network. You can either export a real block device (for instance
> + "/dev/hda1"), a normal file (such as "/export/nbd/bl1"), or a
> + bunch of files all at once. For the latter option, you may
> + use "%s" in the filename, which will be expanded to the
> IP-address of the connecting client. An example would be
> "/export/swaps/swp%s".
"Either" of three options _and_ "the latter" of three? Styleguides
say those have to be binary... which fills me with an urge to find a
third way of contravening the same rule, but instead:
Please specify a file name or block device that should be exported
over the network. You can export a real block device (for instance
"/dev/hda1"); a normal file (such as "/export/nbd/bl1"); or a
bunch of files all at once. For the third option, you can
> .
> Note that the current version of the nbd-server package no longer uses
> /etc/nbd-server; rather, it uses a new configuration file that is read by
> nbd-server itself (rather than the initscript), and which allows to set more
> + options. See "man 5 nbd-server" for details.
Our old friend "allow" without an object - disallowed. Say "and
which supports more options". Oh, except that the "andwhich" breaks
the previous "that":
Note that the current version of the nbd-server package no longer uses
/etc/nbd-server. Instead it uses a new configuration file, read by
nbd-server itself (rather than the initscript), which supports more
options. See "man 5 nbd-server" for details.
> - If you remove or uncomment the AUTO_GEN line, a file
> - /etc/nbd-server/config in the new format may be generated based on your
> - current configuration. Until then, your nbd-server installation will be
> + If you remove or comment the AUTO_GEN line, a file
> + /etc/nbd-server/config in the new format may be generated based on the
> + current configuration. Until then, the nbd-server installation will be
> broken.
>
> Shouldn't that be "comment" insteast of "uncomment"?
Agreed, but to minimise confusion I'd go for "comment out".
In the package boilerplate:
> + Network Block Device (NBD) is a client/server protocol that
> + emulates a block device (such as a hard disk, a floppy, a CD-ROM, ...)
, or a CDROM)
That " ...)" phrasing for an open-ended list makes sense, but isn't
commonly used by English native speakers. Besides, the list's
already flagged as nonexhaustive by the "such as".
> over the network, thus giving the system the ability to swap over the
> network, or to use raw network diskspace for other purposes.
This overuses the word "network", but I don't see an alternative.
> .
> Note, however, that it is not recommended to write to a single
> networked block device from different clients simultaneously, since
??
> that would probably result in data loss; if you want different
> + clients to use the same shared network resource, you should use
> + a network file system such as NFS or CODA.
Coda
Still one big sentence - find a break. And at last there's an
opportunity for eliminating a use of the word "network".
However, writing to one Network Block Device from different clients
simultaneously is not recommended, and would probably result in data
loss. If you want multiple clients to share a remote resource, use a
network file system such as NFS or Coda.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- ../nbd-2.9.11.pristine/debian/nbd-client.templates 2009-04-29 21:44:46.000000000 +0100
+++ debian/nbd-client.templates 2009-04-29 21:50:15.000000000 +0100
@@ -1,9 +1,8 @@
Template: nbd-client/no-auto-config
Type: error
-_Description: AUTO_GEN is set at "n" in /etc/nbd-client.
- There's a line in /etc/nbd-client that reads "AUTO_GEN=n" -- or
- something likewise in sh-syntaxis. This means you don't want me to
- automatically regenerate that file.
+_Description: AUTO_GEN is set to "n" in /etc/nbd-client
+ The /etc/nbd-client file contains a line that sets the AUTO_GEN variable
+ to "n". The file will therefore not be regenerated automatically.
.
If that's wrong, remove the line and call "dpkg-reconfigure nbd-client"
afterwards.
@@ -11,8 +10,8 @@
Template: nbd-client/number
Type: string
Default: 0
-_Description: How many nbd-client connections do you want to use?
- nbd-client can handle multiple concurrent connections. Please state the
+_Description: Number of nbd-client connections to use:
+ nbd-client can handle multiple concurrent connections. Please specify the
number of connections you'd like this configuration script to set up.
.
Note that if something has already been specified in /etc/nbd-client, the
@@ -22,7 +21,7 @@
Type: select
_Choices: swap, filesystem, raw
Default: raw
-_Description: How do you intend to use the network block device (number: ${number})?
+_Description: Intended use of the network block device number ${number}:
The network block device can serve multiple purposes. One of the most
interesting is to provide swapspace over the network for diskless clients,
but you can store a filesystem on it, or do other things with it for which
@@ -38,17 +37,13 @@
Template: nbd-client/host
Type: string
_Description: Hostname of the server (number: ${number})?
- You need to fill in some name with which to resolve the machine on which
- the nbd-server process is running. This can be its hostname (also known to
- some as its "network name") or its IP-address.
+ Please enter the network name or IP address of the machine on which
+ the nbd-server process is running.
Template: nbd-client/port
Type: string
_Description: Port on which the nbd-server is running (number: ${number})?
- You need to fill in the portnumber on which the nbd-server is running.
- This could technically be any number between 1 and 65535, but for this to
- work, it needs to be the one on which a server can be found on the machine
- running nbd-server...
+ Please enter the TCP port number to access nbd-server.
Template: nbd-client/device
Type: string
@@ -58,21 +53,18 @@
this nbd-client. Note that this needs to be the full path to that entry,
not just the last part.
.
- If an unexisting /dev entry is provided, it will be created with minor
- number ${number}
+ If the /dev entry specified does not exist, it will be created with minor
+ number ${number}.
Template: nbd-client/killall
Type: boolean
Default: true
-_Description: Kill all nbd devices on 'stop'?
+_Description: Unmount all NBD devices on "stop"?
When the nbd-client initscript is called to stop the nbd-client
service, there are two things that can be done: either it can stop all
nbd-client devices, or it can stop only those nbd-client devices that
it knows about in its config file.
.
- The traditional behaviour was to stop all nbd-client devices, including
- those that were not specified in the nbd-client config file; for that
- reason, the default answer is to kill all nbd devices. However, if you
- are running critical file systems, such as your root device, on NBD,
- then this is a bad idea; in that case, please do not accept this
- option.
+ The traditional behavior is to unmount all nbd-client devices, but this
+ default should not be accepted if the root device or other critical file
+ systems are on NBD.
--- ../nbd-2.9.11.pristine/debian/nbd-server.templates 2009-04-29 21:44:46.000000000 +0100
+++ debian/nbd-server.templates 2009-04-29 21:56:11.000000000 +0100
@@ -1,36 +1,32 @@
Template: nbd-server/number
Type: string
Default: 0
-_Description: How many nbd-servers do you want to run?
- You can run multiple nbd-server processes, to export multiple files or
- block devices. Please specify how many nbd-server configurations you
- want this configuration script to generate.
+_Description: Number of nbd-server instances to run:
+ Multiple nbd-server processes may run to export multiple files or
+ block devices. Please specify how many configurations for such servers you
+ want to generate.
.
Note that you can always add extra servers by adding them to
- /etc/nbd-server/config, or by running 'dpkg-reconfigure nbd-server'.
+ /etc/nbd-server/config, or by running "dpkg-reconfigure nbd-server".
Template: nbd-server/port
Type: string
-_Description: What port do you want to run the server on (number: ${number})?
- A port is a number in the TCP-header of a TCP/IP network package, that
- defines which application should process the data being sent. For most
- application-layer protocols, like FTP, HTTP, POP3 or SMTP, these numbers
- have been well-defined by IANA, and can be found in /etc/services or STD
- 2; for NBD, however, this would not be appropriate since NBD works with a
- separate port for each and every block device being used.
- .
- Therefore, NBD does not have a standard portnumber, which means you need
- to enter one. Make sure the portnumber being entered is not in use
- already.
+_Description: TCP Port for server number ${number}:
+ Please specify the TCP port this instance of nbd server will use for
+ listening. As NBD is likely to use more than one port, no dedicated
+ port has been assigned in IANA lists.
+ .
+ Therefore, NBD does not have a standard port number, which means you need
+ to provide one. You should make sure this port is not already in use.
Template: nbd-server/filename
Type: string
-_Description: What file do you want to export (number: ${number})?
- You need to enter a filename to a file or block device you want to export
- over the network. You can either export a real block device (e.g.
- "/dev/hda1"), export a normal file (e.g. "/export/nbd/bl1"), or export a
- bunch of files all at once; for the last option, you have the
- possibility to use "%s" in the filename, which will be expanded to the
+_Description: File to export (server number ${number}):
+ Please specify a file name or block device that should be exported
+ over the network. You can export a real block device (for instance
+ "/dev/hda1"); a normal file (such as "/export/nbd/bl1"); or a
+ bunch of files all at once. For the third option, you can
+ use "%s" in the filename, which will be expanded to the
IP-address of the connecting client. An example would be
"/export/swaps/swp%s".
.
@@ -39,35 +35,33 @@
Template: nbd-server/autogen
Type: error
-_Description: AUTO_GEN is set at "n" in /etc/nbd-server
- /etc/nbd-server contains a line "AUTO_GEN=n" -- or something equivalent in
- bash-syntaxis. This means you don't want me to automatically regenerate
- that file.
+_Description: AUTO_GEN is set to "n" in /etc/nbd-server
+ The /etc/nbd-server file contains a line that sets the AUTO_GEN variable
+ to "n". The file will therefore not be regenerated automatically.
.
Note that the current version of the nbd-server package no longer uses
- /etc/nbd-server; rather, it uses a new configuration file that is read by
- nbd-server itself (rather than the initscript), and which allows to set more
- options. See 'man 5 nbd-server' for details.
- .
- If you remove or uncomment the AUTO_GEN line, a file
- /etc/nbd-server/config in the new format may be generated based on your
- current configuration. Until then, your nbd-server installation will be
+ /etc/nbd-server. Instead it uses a new configuration file, read by
+ nbd-server itself (rather than the initscript), which supports more
+ options. See "man 5 nbd-server" for details.
+ .
+ If you remove or comment out the AUTO_GEN line, a file
+ /etc/nbd-server/config in the new format may be generated based on the
+ current configuration. Until then, the nbd-server installation will be
broken.
Template: nbd-server/convert
Type: boolean
Default: true
-_Description: Convert old style nbd-server configuration file?
- A pre-2.9 nbd-server configuration file has been found on your system.
- The current nbd-server package no longer supports this file; if you
- depend on it, your nbd-server no longer works. If you accept this
+_Description: Convert old-style nbd-server configuration file?
+ A pre-2.9 nbd-server configuration file has been found on this system.
+ The current nbd-server package no longer supports this file and will
+ not work if it is kept as is.
+ .
+ If you choose this
option, the system will generate a new style configuration file based
- upon your old style configuration file. Then, the old style
- configuration file will be removed. If you do not accept this option, a
- new style configuration file will be generated based on a number of
- questions that will be asked; these may be the very same questions that
- you used to create the old style configuration file in the first place.
+ upon the old-style configuration file, which will be removed. Otherwise,
+ configuration questions will be asked and the system will generate a new configuration file.
.
- If you already have a new style configuration file and you accept this
+ If a new-style configuration file already exists and you choose this
option, you will shortly see a "modified configuration file" prompt, as
usual.
--- ../nbd-2.9.11.pristine/debian/control 2009-04-29 21:44:46.000000000 +0100
+++ debian/control 2009-04-29 22:10:02.000000000 +0100
@@ -8,36 +8,34 @@
Package: nbd-server
Architecture: any
Depends: ${shlibs:Depends}, debconf (>= 1.2.9) | debconf-2.0, ucf, adduser, ${misc:Depends}
-Description: the Network Block Device server
- This package contains the server process for the Network Block
- Device. The Network Block Device is a client/server protocol that
- emulates a block device (like a hard disk, a floppy, a CD-ROM, ...)
+Description: Network Block Device protocol - server
+ Network Block Device (NBD) is a client/server protocol that
+ emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
over the network, thus giving the system the ability to swap over the
network, or to use raw network diskspace for other purposes.
.
- Note, however, that it is not recommended to write to a single
- networked block device from different clients simultaneously, since
- that would probably result in data loss; if you want different
- clients to use the same shared network resource, you don't need the
- Network Block Device (which, basically, is a Disk Server protocol)
- but something else, like Sun's Network File System (NFS), or CODA.
+ However, writing to one Network Block Device from different clients
+ simultaneously is not recommended, and would probably result in data
+ loss. If you want multiple clients to share a remote resource, use a
+ network file system such as NFS or Coda.
+ .
+ This package provides the server binary for NBD.
Package: nbd-client
Architecture: alpha amd64 arm armeb armel hppa i386 ia64 lpia m32r m68k mips mipsel powerpc ppc64 s390 sh3 sh3eb sh4 sh4eb sparc
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
-Description: the Network Block Device client
- This package contains the client process for the Network Block
- Device. The Network Block Device is a client/server protocol that
- emulates a block device (like a hard disk, a floppy, a CD-ROM, ...)
+Description: Network Block Device protocol - client
+ Network Block Device (NBD) is a client/server protocol that
+ emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
over the network, thus giving the system the ability to swap over the
network, or to use raw network diskspace for other purposes.
.
- Note, however, that it is not recommended to write to a single
- networked block device from different clients simultaneously, since
- that would probably result in data loss; if you want different
- clients to use the same shared network resource, you don't need the
- Network Block Device (which, basically, is a Disk Server protocol)
- but something else, like Sun's Network File System (NFS), or CODA.
+ However, writing to one Network Block Device from different clients
+ simultaneously is not recommended, and would probably result in data
+ loss. If you want multiple clients to share a remote resource, use a
+ network file system such as NFS or Coda.
+ .
+ This package provides the client binary for NBD.
Package: nbd-client-udeb
Section: debian-installer
@@ -45,6 +43,12 @@
Depends: ${shlibs:Depends}
XC-Package-Type: udeb
Architecture: alpha amd64 arm armeb armel hppa i386 ia64 lpia m32r m68k mips mipsel powerpc ppc64 s390 sh3 sh3eb sh4 sh4eb sparc
-Description: the Network Block Device client
- This package contains the client process for the Network Block Device.
+Description: Network Block Device protocol - client for Debian Installer
+ Network Block Device (NBD) is a client/server protocol that
+ emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
+ over the network, thus giving the system the ability to swap over the
+ network, or to use raw network diskspace for other purposes.
+ .
+ This package provides the client binary for NBD.
+ .
It is a minimal version meant for use in the installer only.
Template: nbd-client/no-auto-config
Type: error
_Description: AUTO_GEN is set to "n" in /etc/nbd-client
The /etc/nbd-client file contains a line that sets the AUTO_GEN variable
to "n". The file will therefore not be regenerated automatically.
.
If that's wrong, remove the line and call "dpkg-reconfigure nbd-client"
afterwards.
Template: nbd-client/number
Type: string
Default: 0
_Description: Number of nbd-client connections to use:
nbd-client can handle multiple concurrent connections. Please specify the
number of connections you'd like this configuration script to set up.
.
Note that if something has already been specified in /etc/nbd-client, the
current configuration will be used as defaults in these dialogs.
Template: nbd-client/type
Type: select
_Choices: swap, filesystem, raw
Default: raw
_Description: Intended use of the network block device number ${number}:
The network block device can serve multiple purposes. One of the most
interesting is to provide swapspace over the network for diskless clients,
but you can store a filesystem on it, or do other things with it for which
a block device is interesting.
.
If you intend to use the network block device as a swapdevice, choose
"swap". If you intend to use it as a filesystem, add a line to /etc/fstab,
give it the option "_netdev" (else init will try to mount it before it's
usable), and choose "filesystem". For all other purposes, choose "raw".
The only thing the nbd-client bootscript will do then is start an
nbd-client process; you will have to set it up manually.
Template: nbd-client/host
Type: string
_Description: Hostname of the server (number: ${number})?
Please enter the network name or IP address of the machine on which
the nbd-server process is running.
Template: nbd-client/port
Type: string
_Description: Port on which the nbd-server is running (number: ${number})?
Please enter the TCP port number to access nbd-server.
Template: nbd-client/device
Type: string
_Description: /dev entry for this nbd-client (number: ${number})?
Every nbd-client process needs to be associated with a /dev entry with
major mode 43. Please enter the name of the /dev entry you want to use for
this nbd-client. Note that this needs to be the full path to that entry,
not just the last part.
.
If the /dev entry specified does not exist, it will be created with minor
number ${number}.
Template: nbd-client/killall
Type: boolean
Default: true
_Description: Unmount all NBD devices on "stop"?
When the nbd-client initscript is called to stop the nbd-client
service, there are two things that can be done: either it can stop all
nbd-client devices, or it can stop only those nbd-client devices that
it knows about in its config file.
.
The traditional behavior is to unmount all nbd-client devices, but this
default should not be accepted if the root device or other critical file
systems are on NBD.
Template: nbd-server/number
Type: string
Default: 0
_Description: Number of nbd-server instances to run:
Multiple nbd-server processes may run to export multiple files or
block devices. Please specify how many configurations for such servers you
want to generate.
.
Note that you can always add extra servers by adding them to
/etc/nbd-server/config, or by running "dpkg-reconfigure nbd-server".
Template: nbd-server/port
Type: string
_Description: TCP Port for server number ${number}:
Please specify the TCP port this instance of nbd server will use for
listening. As NBD is likely to use more than one port, no dedicated
port has been assigned in IANA lists.
.
Therefore, NBD does not have a standard port number, which means you need
to provide one. You should make sure this port is not already in use.
Template: nbd-server/filename
Type: string
_Description: File to export (server number ${number}):
Please specify a file name or block device that should be exported
over the network. You can export a real block device (for instance
"/dev/hda1"); a normal file (such as "/export/nbd/bl1"); or a
bunch of files all at once. For the third option, you can
use "%s" in the filename, which will be expanded to the
IP-address of the connecting client. An example would be
"/export/swaps/swp%s".
.
Note that it is possible to tune the way in which the IP address will
be substituted in the file name. See "man 5 nbd-server" for details.
Template: nbd-server/autogen
Type: error
_Description: AUTO_GEN is set to "n" in /etc/nbd-server
The /etc/nbd-server file contains a line that sets the AUTO_GEN variable
to "n". The file will therefore not be regenerated automatically.
.
Note that the current version of the nbd-server package no longer uses
/etc/nbd-server. Instead it uses a new configuration file, read by
nbd-server itself (rather than the initscript), which supports more
options. See "man 5 nbd-server" for details.
.
If you remove or comment out the AUTO_GEN line, a file
/etc/nbd-server/config in the new format may be generated based on the
current configuration. Until then, the nbd-server installation will be
broken.
Template: nbd-server/convert
Type: boolean
Default: true
_Description: Convert old-style nbd-server configuration file?
A pre-2.9 nbd-server configuration file has been found on this system.
The current nbd-server package no longer supports this file and will
not work if it is kept as is.
.
If you choose this
option, the system will generate a new style configuration file based
upon the old-style configuration file, which will be removed. Otherwise,
configuration questions will be asked and the system will generate a new configuration file.
.
If a new-style configuration file already exists and you choose this
option, you will shortly see a "modified configuration file" prompt, as
usual.
Source: nbd
Section: admin
Priority: optional
Maintainer: Wouter Verhelst <wouter@debian.org>
Build-Depends: debhelper (>> 4.1.16), libglib2.0-dev
Standards-Version: 3.8.0
Package: nbd-server
Architecture: any
Depends: ${shlibs:Depends}, debconf (>= 1.2.9) | debconf-2.0, ucf, adduser, ${misc:Depends}
Description: Network Block Device protocol - server
Network Block Device (NBD) is a client/server protocol that
emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
over the network, thus giving the system the ability to swap over the
network, or to use raw network diskspace for other purposes.
.
However, writing to one Network Block Device from different clients
simultaneously is not recommended, and would probably result in data
loss. If you want multiple clients to share a remote resource, use a
network file system such as NFS or Coda.
.
This package provides the server binary for NBD.
Package: nbd-client
Architecture: alpha amd64 arm armeb armel hppa i386 ia64 lpia m32r m68k mips mipsel powerpc ppc64 s390 sh3 sh3eb sh4 sh4eb sparc
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Description: Network Block Device protocol - client
Network Block Device (NBD) is a client/server protocol that
emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
over the network, thus giving the system the ability to swap over the
network, or to use raw network diskspace for other purposes.
.
However, writing to one Network Block Device from different clients
simultaneously is not recommended, and would probably result in data
loss. If you want multiple clients to share a remote resource, use a
network file system such as NFS or Coda.
.
This package provides the client binary for NBD.
Package: nbd-client-udeb
Section: debian-installer
Priority: optional
Depends: ${shlibs:Depends}
XC-Package-Type: udeb
Architecture: alpha amd64 arm armeb armel hppa i386 ia64 lpia m32r m68k mips mipsel powerpc ppc64 s390 sh3 sh3eb sh4 sh4eb sparc
Description: Network Block Device protocol - client for Debian Installer
Network Block Device (NBD) is a client/server protocol that
emulates a block device (such as a hard disk, a floppy, or a CD-ROM)
over the network, thus giving the system the ability to swap over the
network, or to use raw network diskspace for other purposes.
.
This package provides the client binary for NBD.
.
It is a minimal version meant for use in the installer only.
Reply to: