[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[RFR] templates://nethack/{nethack-common.templates}



Please find, for review, the debconf templates and packages descriptions for the nethack source package.

This review will last from Thursday, February 26, 2009 to Sunday, March 08, 2009.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.

Rationale:
--- nethack.old/debian/nethack-common.templates	2009-02-14 12:18:34.067868635 +0100
+++ nethack/debian/nethack-common.templates	2009-02-19 07:29:02.930519759 +0100
@@ -1,34 +1,17 @@
-Template: nethack-common/backup-incompatible
-Type: select
-_Choices: abort, backup, purge, ignore
-Default: backup
-_Description: Should NetHack back up your old, incompatible save files?
- You are upgrading from a version of NetHack whose save files are not
- compatible with the version you are upgrading to. You may either have them
- backed up into /tmp, purge them, ignore this problem completely, or abort
- this installation and manually handle NetHack's save files. Your score files
- will be lost if you choose to purge.
- .
- If you choose to back up, the files will be backed up into a
- gzip-compressed tar archive in /tmp with a random name starting
- with 'nethk' and ending in '.tar.gz'.
- .
- Old NetHack save files can be found in /var/games/nethack (or
- /var/lib/games/nethack, for versions before 3.4.0).
-

Should be dropped. Deals with an obsolete transition (I reported a
separate bug for this)


 Template: nethack-common/recover-setgid
 Type: boolean
 Default: false
-_Description: Would you like NetHack's recover utility to be setgid games?
- The 'recover' program is installed as part of the nethack-common package
+_Description: Use setgid bit with NetHack's recover utility?

Standard style in such cases

+ The "recover" program is installed as part of the nethack-common package

Use of double quotes

  and exists to help the administrator recover broken save files, etc.
  . 
- Recover is traditionally installed setgid games, although it does not
- need to be in the Debian NetHack installation, as it is automatically
- run at boot time as root. Its only usefulness as a setgid binary is
- to let players as normal users on the system recover their save
+ Recover is traditionally installed with the "setgid" bit (group "games").
+ However, this package runs it automatically, as root, during the system
+ boot. As a consequence, allowing the utility to use the "games" group
+ privileges is only useful
+ to let players recover their save
  files, should NetHack crash or their connection drop mid-game.

Let be more explicit about what a setgid binary is. "Installed setgid
games" is jargon.

Rephrase to make the template less clumky. Not sure that I succeed...:-)

  .
- If you answer no, you will have to run recover as root or as someone
- in group games to recover save files after a crash or a connection
- drop.
+ If you do not choose this option, recovers after a crash or a connection
+ drop can only be run as root or by a user who is member of the "games"
+ group.

Avoid "answer no" (see Developer's Refeence for rationaleà

--- nethack.old/debian/control	2009-02-14 12:18:34.003868468 +0100
+++ nethack/debian/control	2009-02-26 07:28:41.176497373 +0100
@@ -11,35 +11,38 @@
 Recommends: nethack-console | nethack-x11 | nethack-qt
 Conflicts: suidmanager (<< 0.50), nethack-console (<< ${binary:Version}), nethack-x11 (<< ${binary:Version}), nethack-gnome (<< ${binary:Version}), nethack-qt (<< ${binary:Version}), nethack-lisp (<< ${binary:Version})
 Replaces: nethack (<< 3.4.0)
-Description: Common files for Nethack dungeon crawl game
+Description: dungeon crawl game - common files

Standardize the packages' description with a "common part - specific
part" layout.

+ Nethack is a wonderfully silly, yet quite addicting, Dungeons and
+ Dragons-style adventure game. You play the part of a fierce fighter,
+ wizard, or any of many other classes, fighting your way down to
+ retrieve the Amulet of Yendor (try saying THAT one backwards!) for
+ your god. On the way, you might encounter a quantum mechanic or two,
+ or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
+ the Ravenous Bugblatter Beast of Traal.
+ .
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .

That will be the boilerplate for all packages. I decided to keep the
original wording, including its style, which is not precisely the very
neutral style we like in packages' descriptions.....but we're talking
about a game here....and, moreover, a well known game in the
(old-style) geek community. So, the description is part of some
tradition....with a nice reference to *the* Monthy Python most
achieved movie..:)


  The various graphical front-ends for Nethack all share a large
  number of files in common.  This package contains the graphics,
  dungeon levels, and utilities common to all Nethack front-ends.
- . 
- Please install one of the following Nethack front-ends if you
- actually wish to play the game.  Each of them includes the
- original non-graphical version, and they can all be installed
- at the same time.
  .
-  * nethack-console (no graphics, just plain Nethack)
-  * nethack-x11 (original X11/Athena-based graphical version)
-  * nethack-qt (newer Qt-based graphical version)
-  * nethack-lisp (for playing Nethack in Emacs; requires nethack-el)
- .
- There is a nethack-spoilers package available, if you're really
- desperate for help.
- .

That last paragraphs maybe belongs to README.Debian?

- A few utilities -- recover, for retrieving your auto-save files in case
+ It also provides a few utilities such as recover, for retrieving auto-save files in case
  of a power failure, and dgn_comp and lev_comp, two utilities for making
- your own Nethack levels and dungeons, have been included in
- /usr/lib/games/nethack. 'recover' will be run every time your system
+ your own Nethack levels and dungeons. The "recover" may be run every time the system
  boots, if there are any auto-save files available.

Rephrase in a more common style.


....all other changes in following packages try to follow the same principles.
 

Template: nethack-common/recover-setgid
Type: boolean
Default: false
_Description: Use setgid bit with NetHack's recover utility?
 The "recover" program is installed as part of the nethack-common package
 and exists to help the administrator recover broken save files, etc.
 . 
 Recover is traditionally installed with the "setgid" bit (group "games").
 However, this package runs it automatically, as root, during the system
 boot. As a consequence, allowing the utility to use the "games" group
 privileges is only useful
 to let players recover their save
 files, should NetHack crash or their connection drop mid-game.
 .
 If you do not choose this option, recovers after a crash or a connection
 drop can only be run as root or by a user who is member of the "games"
 group.
--- nethack.old/debian/nethack-common.templates	2009-02-14 12:18:34.067868635 +0100
+++ nethack/debian/nethack-common.templates	2009-02-19 07:29:02.930519759 +0100
@@ -1,34 +1,17 @@
-Template: nethack-common/backup-incompatible
-Type: select
-_Choices: abort, backup, purge, ignore
-Default: backup
-_Description: Should NetHack back up your old, incompatible save files?
- You are upgrading from a version of NetHack whose save files are not
- compatible with the version you are upgrading to. You may either have them
- backed up into /tmp, purge them, ignore this problem completely, or abort
- this installation and manually handle NetHack's save files. Your score files
- will be lost if you choose to purge.
- .
- If you choose to back up, the files will be backed up into a
- gzip-compressed tar archive in /tmp with a random name starting
- with 'nethk' and ending in '.tar.gz'.
- .
- Old NetHack save files can be found in /var/games/nethack (or
- /var/lib/games/nethack, for versions before 3.4.0).
-
 Template: nethack-common/recover-setgid
 Type: boolean
 Default: false
-_Description: Would you like NetHack's recover utility to be setgid games?
- The 'recover' program is installed as part of the nethack-common package
+_Description: Use setgid bit with NetHack's recover utility?
+ The "recover" program is installed as part of the nethack-common package
  and exists to help the administrator recover broken save files, etc.
  . 
- Recover is traditionally installed setgid games, although it does not
- need to be in the Debian NetHack installation, as it is automatically
- run at boot time as root. Its only usefulness as a setgid binary is
- to let players as normal users on the system recover their save
+ Recover is traditionally installed with the "setgid" bit (group "games").
+ However, this package runs it automatically, as root, during the system
+ boot. As a consequence, allowing the utility to use the "games" group
+ privileges is only useful
+ to let players recover their save
  files, should NetHack crash or their connection drop mid-game.
  .
- If you answer no, you will have to run recover as root or as someone
- in group games to recover save files after a crash or a connection
- drop.
+ If you do not choose this option, recovers after a crash or a connection
+ drop can only be run as root or by a user who is member of the "games"
+ group.
--- nethack.old/debian/control	2009-02-14 12:18:34.003868468 +0100
+++ nethack/debian/control	2009-02-26 07:28:41.176497373 +0100
@@ -11,35 +11,38 @@
 Recommends: nethack-console | nethack-x11 | nethack-qt
 Conflicts: suidmanager (<< 0.50), nethack-console (<< ${binary:Version}), nethack-x11 (<< ${binary:Version}), nethack-gnome (<< ${binary:Version}), nethack-qt (<< ${binary:Version}), nethack-lisp (<< ${binary:Version})
 Replaces: nethack (<< 3.4.0)
-Description: Common files for Nethack dungeon crawl game
+Description: dungeon crawl game - common files
+ Nethack is a wonderfully silly, yet quite addicting, Dungeons and
+ Dragons-style adventure game. You play the part of a fierce fighter,
+ wizard, or any of many other classes, fighting your way down to
+ retrieve the Amulet of Yendor (try saying THAT one backwards!) for
+ your god. On the way, you might encounter a quantum mechanic or two,
+ or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
+ the Ravenous Bugblatter Beast of Traal.
+ .
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .
  The various graphical front-ends for Nethack all share a large
  number of files in common.  This package contains the graphics,
  dungeon levels, and utilities common to all Nethack front-ends.
- . 
- Please install one of the following Nethack front-ends if you
- actually wish to play the game.  Each of them includes the
- original non-graphical version, and they can all be installed
- at the same time.
  .
-  * nethack-console (no graphics, just plain Nethack)
-  * nethack-x11 (original X11/Athena-based graphical version)
-  * nethack-qt (newer Qt-based graphical version)
-  * nethack-lisp (for playing Nethack in Emacs; requires nethack-el)
- .
- There is a nethack-spoilers package available, if you're really
- desperate for help.
- .
- A few utilities -- recover, for retrieving your auto-save files in case
+ It also provides a few utilities such as recover, for retrieving auto-save files in case
  of a power failure, and dgn_comp and lev_comp, two utilities for making
- your own Nethack levels and dungeons, have been included in
- /usr/lib/games/nethack. 'recover' will be run every time your system
+ your own Nethack levels and dungeons. The "recover" may be run every time the system
  boots, if there are any auto-save files available.
 
 Package: nethack-console
 Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
 Architecture: any
 Provides: nethack
-Description: Text-based overhead view D&D-style adventure game
+Description: dungeon crawl game - text-based interface
  Nethack is a wonderfully silly, yet quite addicting, Dungeons and
  Dragons-style adventure game. You play the part of a fierce fighter,
  wizard, or any of many other classes, fighting your way down to
@@ -48,15 +51,23 @@
  or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
  the Ravenous Bugblatter Beast of Traal.
  .
- This package contains the plain console version of Nethack.  No
- graphics here!
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .
+ This package provides the plain console version of Nethack.
 
 Package: nethack-lisp
 Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
 Suggests: nethack-el
 Architecture: any
 Provides: nethack
-Description: Text-based overhead view D&D-style adventure game
+Description: dungeon crawl game - EMacs interface
  Nethack is a wonderfully silly, yet quite addicting, Dungeons and
  Dragons-style adventure game. You play the part of a fierce fighter,
  wizard, or any of many other classes, fighting your way down to
@@ -65,14 +76,23 @@
  or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
  the Ravenous Bugblatter Beast of Traal.
  .
- This package contains the Lisp window version, required
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .
+ This package povides the Lisp window version, required
  for playing Nethack under Emacs.
 
 Package: nethack-x11
 Depends: ${shlibs:Depends}, ${misc:Depends}, nethack-common (= ${binary:Version}), xbase-clients (>= 3.3.3.1-5)
 Architecture: any
 Provides: nethack
-Description: Text-based/X11 overhead view D&D-style adventure game
+Description: dungeon crawl game - X11 interface
  Nethack is a wonderfully silly, yet quite addicting, Dungeons and
  Dragons-style adventure game. You play the part of a fierce fighter,
  wizard, or any of many other classes, fighting your way down to
@@ -81,14 +101,23 @@
  or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
  the Ravenous Bugblatter Beast of Traal.
  .
- This package contains the text and X11/Athena-based graphical versions
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .
+ This package provides the text and X11/Athena-based graphical versions
  of Nethack.
 
 Package: nethack-qt
 Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
 Architecture: any
 Provides: nethack
-Description: Text-based/Qt overhead view D&D-style adventure game
+Description: dungeon crawl game - Qt interface
  Nethack is a wonderfully silly, yet quite addicting, Dungeons and
  Dragons-style adventure game. You play the part of a fierce fighter,
  wizard, or any of many other classes, fighting your way down to
@@ -97,6 +126,15 @@
  or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
  the Ravenous Bugblatter Beast of Traal.
  .
- This package contains the text and Qt-based graphical versions
+ You should install a front-end for Nethack if you
+ wish to play the game.  Each of them includes the
+ original non-graphical version, and they can all be installed
+ at the same time:
+  - nethack-console: no graphics, just plain Nethack;
+  - nethack-x11    : original X11/Athena-based graphical version;
+  - nethack-qt     : Qt-based graphical version;
+  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
+ .
+ This package provides the text and Qt-based graphical versions
  of Nethack.
 
Source: nethack
Section: games
Priority: optional
Maintainer: Joshua Kwan <joshk@triplehelix.org>
Standards-Version: 3.7.2
Build-Depends: flex, bison, groff-base, debhelper (>= 5.0.31), libx11-dev, libxt-dev, libxext-dev, libxmu-dev, xutils, bsdmainutils, libxaw7-dev | libxaw-dev, libncurses5-dev | libncurses-dev, libqt3-mt-dev (>= 3:3.3.4-7), dpatch, po-debconf

Package: nethack-common
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debianutils (>= 1.12)
Recommends: nethack-console | nethack-x11 | nethack-qt
Conflicts: suidmanager (<< 0.50), nethack-console (<< ${binary:Version}), nethack-x11 (<< ${binary:Version}), nethack-gnome (<< ${binary:Version}), nethack-qt (<< ${binary:Version}), nethack-lisp (<< ${binary:Version})
Replaces: nethack (<< 3.4.0)
Description: dungeon crawl game - common files
 Nethack is a wonderfully silly, yet quite addicting, Dungeons and
 Dragons-style adventure game. You play the part of a fierce fighter,
 wizard, or any of many other classes, fighting your way down to
 retrieve the Amulet of Yendor (try saying THAT one backwards!) for
 your god. On the way, you might encounter a quantum mechanic or two,
 or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
 the Ravenous Bugblatter Beast of Traal.
 .
 You should install a front-end for Nethack if you
 wish to play the game.  Each of them includes the
 original non-graphical version, and they can all be installed
 at the same time:
  - nethack-console: no graphics, just plain Nethack;
  - nethack-x11    : original X11/Athena-based graphical version;
  - nethack-qt     : Qt-based graphical version;
  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
 .
 The various graphical front-ends for Nethack all share a large
 number of files in common.  This package contains the graphics,
 dungeon levels, and utilities common to all Nethack front-ends.
 .
 It also provides a few utilities such as recover, for retrieving auto-save files in case
 of a power failure, and dgn_comp and lev_comp, two utilities for making
 your own Nethack levels and dungeons. The "recover" may be run every time the system
 boots, if there are any auto-save files available.

Package: nethack-console
Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
Architecture: any
Provides: nethack
Description: dungeon crawl game - text-based interface
 Nethack is a wonderfully silly, yet quite addicting, Dungeons and
 Dragons-style adventure game. You play the part of a fierce fighter,
 wizard, or any of many other classes, fighting your way down to
 retrieve the Amulet of Yendor (try saying THAT one backwards!) for
 your god. On the way, you might encounter a quantum mechanic or two,
 or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
 the Ravenous Bugblatter Beast of Traal.
 .
 You should install a front-end for Nethack if you
 wish to play the game.  Each of them includes the
 original non-graphical version, and they can all be installed
 at the same time:
  - nethack-console: no graphics, just plain Nethack;
  - nethack-x11    : original X11/Athena-based graphical version;
  - nethack-qt     : Qt-based graphical version;
  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
 .
 This package provides the plain console version of Nethack.

Package: nethack-lisp
Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
Suggests: nethack-el
Architecture: any
Provides: nethack
Description: dungeon crawl game - EMacs interface
 Nethack is a wonderfully silly, yet quite addicting, Dungeons and
 Dragons-style adventure game. You play the part of a fierce fighter,
 wizard, or any of many other classes, fighting your way down to
 retrieve the Amulet of Yendor (try saying THAT one backwards!) for
 your god. On the way, you might encounter a quantum mechanic or two,
 or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
 the Ravenous Bugblatter Beast of Traal.
 .
 You should install a front-end for Nethack if you
 wish to play the game.  Each of them includes the
 original non-graphical version, and they can all be installed
 at the same time:
  - nethack-console: no graphics, just plain Nethack;
  - nethack-x11    : original X11/Athena-based graphical version;
  - nethack-qt     : Qt-based graphical version;
  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
 .
 This package povides the Lisp window version, required
 for playing Nethack under Emacs.

Package: nethack-x11
Depends: ${shlibs:Depends}, ${misc:Depends}, nethack-common (= ${binary:Version}), xbase-clients (>= 3.3.3.1-5)
Architecture: any
Provides: nethack
Description: dungeon crawl game - X11 interface
 Nethack is a wonderfully silly, yet quite addicting, Dungeons and
 Dragons-style adventure game. You play the part of a fierce fighter,
 wizard, or any of many other classes, fighting your way down to
 retrieve the Amulet of Yendor (try saying THAT one backwards!) for
 your god. On the way, you might encounter a quantum mechanic or two,
 or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
 the Ravenous Bugblatter Beast of Traal.
 .
 You should install a front-end for Nethack if you
 wish to play the game.  Each of them includes the
 original non-graphical version, and they can all be installed
 at the same time:
  - nethack-console: no graphics, just plain Nethack;
  - nethack-x11    : original X11/Athena-based graphical version;
  - nethack-qt     : Qt-based graphical version;
  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
 .
 This package provides the text and X11/Athena-based graphical versions
 of Nethack.

Package: nethack-qt
Depends: ${shlibs:Depends}, nethack-common (= ${binary:Version})
Architecture: any
Provides: nethack
Description: dungeon crawl game - Qt interface
 Nethack is a wonderfully silly, yet quite addicting, Dungeons and
 Dragons-style adventure game. You play the part of a fierce fighter,
 wizard, or any of many other classes, fighting your way down to
 retrieve the Amulet of Yendor (try saying THAT one backwards!) for
 your god. On the way, you might encounter a quantum mechanic or two,
 or perhaps a microscopic space fleet, or -- if you're REALLY lucky --
 the Ravenous Bugblatter Beast of Traal.
 .
 You should install a front-end for Nethack if you
 wish to play the game.  Each of them includes the
 original non-graphical version, and they can all be installed
 at the same time:
  - nethack-console: no graphics, just plain Nethack;
  - nethack-x11    : original X11/Athena-based graphical version;
  - nethack-qt     : Qt-based graphical version;
  - nethack-lisp   : Allows playing inside Emacs. It requires nethack-el.
 .
 This package provides the text and Qt-based graphical versions
 of Nethack.

Attachment: signature.asc
Description: Digital signature


Reply to: