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

Bug#652526: [RFR] templates://unixcw/{cwcp.templates,cw.templates}



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

This review will last from Saturday, December 24, 2011 to Tuesday, January 03, 2012.

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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.

Rationale:
--- unixcw.old/debian/cw.templates	2011-12-18 07:47:46.031035453 +0100
+++ unixcw/debian/cw.templates	2011-12-24 09:17:11.835665157 +0100
@@ -1,10 +1,13 @@
 Template: cw/suid_bit
 Type: boolean
 Default: false
-_Description: Make cw setuid root?
- cw can produce sounds using console buzzer, but this feature
- is available only if cw is run by root user.
- You can achieve this by setting setuid bit here (not recommended)
- or by running cw with sudo (also not recommended). You can also
- use soundcard output instead of console buzzer output and
+_Description: Run cw with root privileges?
+ The cw program can produce sounds using console buzzer, but this feature
+ is available only if cw is run by the root user.
+ .
+ This can be achieved by setting the "setuid" bit to
+ execute it with root privileges or by running the program
+ with sudo. Both are not recommended.
+ .
+ Alternatively, you can use soundcard output instead of console buzzer output and
  eliminate this problem completely.

The synopsis makes it clearer about what is "setuid root".

Then avoid starting a sentence with a lowercase letter

Also split into paragraphs for readability and reword in general.

--- unixcw.old/debian/control	2011-12-18 07:47:46.031035453 +0100
+++ unixcw/debian/control	2011-12-22 07:17:04.002961363 +0100
@@ -12,8 +12,8 @@
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Replaces: unixcw
 Recommends: cw | cwcp | xcwcp
-Description: Shared library for Morse programs
- Shared library files for cw, cwcp and xcwcp programs.
+Description: Morse programs - shared library
+ This package provides shared library files for cw, cwcp and xcwcp programs.
  The library handles Morse code signals and generates sound
  on console buzzer or sound card through OSS or ALSA.

Synopsis: use the general convention of "general description -
specific description"

Long description: make a sentence.

 
@@ -22,15 +22,15 @@
 Architecture: any
 Depends: libcw3 (= ${binary:Version}), ${misc:Depends}
 Replaces: unixcw-dev
-Description: Development files for Morse programs
- Static library, headers and manual page for development of
+Description: Morse programs - development files
+ This package provides the static library, headers and manual page for development of
  programs that handle (i.e. send and receive) Morse code.
 
 Package: cw
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
 Description: Morse code tutor with command line user interface
- The package provides two executables:
+ This package provides two executables:
   * cw - simple command line application that converts
     keyboard keys to Morse code that can be heard through
     console buzzer or sound card.

Similar changes....



@@ -46,21 +46,21 @@
 Package: cwcp
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
-Description: Morse code tutor, text user interface
- Interactive Morse code tutor with text-based (ncurses) user
- interface. It allows menu selection from a number of sending
- modes, and also permits character sounding options, such as
+Description: Morse code tutor - text user interface
+ This package provides an interactive Morse code tutor with a text-based (ncurses) user
+ interface. It allows selecting sending
+ modes in menus, and also offers character sounding options, such as
  the tone pitch, and sending speed, to be varied from the
  keyboard using a full-screen user interface.

"It allows".....see http://wiki.debian.org/I18n/SmithDebconfReviewGuidelines

 
 Package: xcwcp
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
-Description: Morse code tutor, X Window user interface
- Interactive Morse code tutor with X Window-based (QT4)
- interface. It lets you choose from a number of options for
+Description: Morse code tutor - X Window user interface
+ This package provides an interactive Morse code tutor with a X Window-based (QT4)
+ interface. It allows choosing from a number of options for
  practice, including sending random characters, random words,
  and characters from the keyboard. It will also receive Morse
- code that you send using the keyboard or mouse as a Morse
+ code sent through with the keyboard or the mouse used as a Morse
  keyer, and display the characters it sees.

Avoid constructions with "you".... 

-- 


Template: cwcp/suid_bit
Type: boolean
Default: false
_Description: Make cwcp setuid root?
 cwcp can produce sounds using console buzzer, but this feature
 is available only if cwcp is run by root user.
 You can achieve this by setting setuid bit here (not recommended)
 or by running cwcp with sudo (also not recommended). You can also
 use soundcard output instead of console buzzer output and
 eliminate this problem completely.
Template: cw/suid_bit
Type: boolean
Default: false
_Description: Run cw with root privileges?
 The cw program can produce sounds using console buzzer, but this feature
 is available only if cw is run by the root user.
 .
 This can be achieved by setting the "setuid" bit to
 execute it with root privileges or by running the program
 with sudo. Both are not recommended.
 .
 Alternatively, you can use soundcard output instead of console buzzer output and
 eliminate this problem completely.
--- unixcw.old/debian/cw.templates	2011-12-18 07:47:46.031035453 +0100
+++ unixcw/debian/cw.templates	2011-12-24 09:17:11.835665157 +0100
@@ -1,10 +1,13 @@
 Template: cw/suid_bit
 Type: boolean
 Default: false
-_Description: Make cw setuid root?
- cw can produce sounds using console buzzer, but this feature
- is available only if cw is run by root user.
- You can achieve this by setting setuid bit here (not recommended)
- or by running cw with sudo (also not recommended). You can also
- use soundcard output instead of console buzzer output and
+_Description: Run cw with root privileges?
+ The cw program can produce sounds using console buzzer, but this feature
+ is available only if cw is run by the root user.
+ .
+ This can be achieved by setting the "setuid" bit to
+ execute it with root privileges or by running the program
+ with sudo. Both are not recommended.
+ .
+ Alternatively, you can use soundcard output instead of console buzzer output and
  eliminate this problem completely.
--- unixcw.old/debian/control	2011-12-18 07:47:46.031035453 +0100
+++ unixcw/debian/control	2011-12-22 07:17:04.002961363 +0100
@@ -12,8 +12,8 @@
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Replaces: unixcw
 Recommends: cw | cwcp | xcwcp
-Description: Shared library for Morse programs
- Shared library files for cw, cwcp and xcwcp programs.
+Description: Morse programs - shared library
+ This package provides shared library files for cw, cwcp and xcwcp programs.
  The library handles Morse code signals and generates sound
  on console buzzer or sound card through OSS or ALSA.
 
@@ -22,15 +22,15 @@
 Architecture: any
 Depends: libcw3 (= ${binary:Version}), ${misc:Depends}
 Replaces: unixcw-dev
-Description: Development files for Morse programs
- Static library, headers and manual page for development of
+Description: Morse programs - development files
+ This package provides the static library, headers and manual page for development of
  programs that handle (i.e. send and receive) Morse code.
 
 Package: cw
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
 Description: Morse code tutor with command line user interface
- The package provides two executables:
+ This package provides two executables:
   * cw - simple command line application that converts
     keyboard keys to Morse code that can be heard through
     console buzzer or sound card.
@@ -46,21 +46,21 @@
 Package: cwcp
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
-Description: Morse code tutor, text user interface
- Interactive Morse code tutor with text-based (ncurses) user
- interface. It allows menu selection from a number of sending
- modes, and also permits character sounding options, such as
+Description: Morse code tutor - text user interface
+ This package provides an interactive Morse code tutor with a text-based (ncurses) user
+ interface. It allows selecting sending
+ modes in menus, and also offers character sounding options, such as
  the tone pitch, and sending speed, to be varied from the
  keyboard using a full-screen user interface.
 
 Package: xcwcp
 Architecture: any
 Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
-Description: Morse code tutor, X Window user interface
- Interactive Morse code tutor with X Window-based (QT4)
- interface. It lets you choose from a number of options for
+Description: Morse code tutor - X Window user interface
+ This package provides an interactive Morse code tutor with a X Window-based (QT4)
+ interface. It allows choosing from a number of options for
  practice, including sending random characters, random words,
  and characters from the keyboard. It will also receive Morse
- code that you send using the keyboard or mouse as a Morse
+ code sent through with the keyboard or the mouse used as a Morse
  keyer, and display the characters it sees.
 
Source: unixcw
Section: hamradio
Priority: optional
Maintainer: Debian Hamradio Maintainers <debian-hams@lists.debian.org>
Uploaders: Kamil Ignacak <acerion@wp.pl>, Kamal Mostafa <kamal@whence.com>
Standards-Version: 3.9.2
Build-Depends: debhelper (>=7), libasound2-dev, libqt4-dev, libncurses5-dev, po-debconf, autotools-dev, mawk|gawk
Homepage: http://unixcw.sourceforge.net/

Package: libcw3
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Replaces: unixcw
Recommends: cw | cwcp | xcwcp
Description: Morse programs - shared library
 This package provides shared library files for cw, cwcp and xcwcp programs.
 The library handles Morse code signals and generates sound
 on console buzzer or sound card through OSS or ALSA.

Package: libcw3-dev
Section: libdevel
Architecture: any
Depends: libcw3 (= ${binary:Version}), ${misc:Depends}
Replaces: unixcw-dev
Description: Morse programs - development files
 This package provides the static library, headers and manual page for development of
 programs that handle (i.e. send and receive) Morse code.

Package: cw
Architecture: any
Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
Description: Morse code tutor with command line user interface
 This package provides two executables:
  * cw - simple command line application that converts
    keyboard keys to Morse code that can be heard through
    console buzzer or sound card.
  * cwgen - program that generates groups of random
    characters for Morse code practice, that can be
    piped to cw program.
 .
 Package also includes examples files with embedded commands.
 These commands can be used to change speed, tone, spacing
 between characters and much more. The files have 'cw'
 extension.

Package: cwcp
Architecture: any
Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
Description: Morse code tutor - text user interface
 This package provides an interactive Morse code tutor with a text-based (ncurses) user
 interface. It allows selecting sending
 modes in menus, and also offers character sounding options, such as
 the tone pitch, and sending speed, to be varied from the
 keyboard using a full-screen user interface.

Package: xcwcp
Architecture: any
Depends: libcw3, ${shlibs:Depends}, ${misc:Depends}, debconf|debconf-2.0
Description: Morse code tutor - X Window user interface
 This package provides an interactive Morse code tutor with a X Window-based (QT4)
 interface. It allows choosing from a number of options for
 practice, including sending random characters, random words,
 and characters from the keyboard. It will also receive Morse
 code sent through with the keyboard or the mouse used as a Morse
 keyer, and display the characters it sees.

Attachment: signature.asc
Description: Digital signature


Reply to: