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

[RFR] templates://canna/{templates,libcanna1g.templates}



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

This review will last from Friday, April 03, 2009 to Monday, April 13, 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:
--- canna.old/debian/templates	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/templates	2009-03-30 07:32:13.574644518 +0200
@@ -1,46 +1,45 @@
 Template: canna/run_cannaserver
 Type: boolean
 Default: true
-_Description: Do you want to run the Canna server ?
+_Description: Do you want to run the Canna server?

Drop extra space

  This package contains the Canna server and server-related
  utilities. If you are only interested in these utilities,
- you can disable the Canna server here.
+ you can disable the Canna server now.

"here" makes a (small) reference to the debconf interface. "now" is
more vague. 
 
 Template: canna/run_with_inet
 Type: boolean
 Default: false
-_Description: Do you want to connect to the Canna server from a remote host?
+_Description: Allow connections to the Canna server from remote hosts?

more than one host will be able to connect

Shorten the sentence: the important point is "allow" not the user
wanting or not..:-)

  The Canna server only allows connections via UNIX domain
- sockets when the `-inet' option is not specified.  This
- means that when the Canna server is started without the `-inet' option,
+ sockets when the "-inet" option is not specified.  This
+ means that when the Canna server is started without the "-inet" option,

Use double quotes

  only clients which run on the same host can connect to the server.
- Some clients such as, `egg' and `yc-el', do not support
- UNIX domain socket and require the `-inet' option, even if they run on
+ Some clients, such as egg and yc-el, do not support
+ UNIX domain socket and require the "-inet" option, even if they run on
  the same host.

I think that quotes are not needed here....and when they are, they
shoul dbe double ;)

  .
- If you want to connect to this Canna server from remote hosts, or
- if you want to use INET-domain-only software, you should run
- the server with the `-inet' option.
+ You should choose this option if you want to connect to this Canna
+ server from remote hosts, or
+ if you want to use inet-domain-only software.

Revert the sentence to make it explicit that "choosing the option" has
this and that consequence.
 
 
 Template: canna/manage_allow_hosts_with_debconf
 Type: boolean
 Default: true
-_Description: Manage /etc/hosts.canna with debconf ?
- /etc/hosts.canna controls which hosts can connect to this server.
+_Description: Manage /etc/hosts.canna automatically?

Direct reference to debconf is discouraged

+ The /etc/hosts.canna file lists hosts allowed to connect to the
+ Canna server server.

Avoid leading slash. The file only lists the hosts. The control is
made by people who fill in the file..:-)

  .
- By default /etc/hosts.canna will be managed with debconf.
- Refuse here if you want to manage /etc/hosts.canna yourself.
+ You should not accept this option if you prefer managing that
+ file's content manually.

Avoid reference to debconf 
 
 Template: canna/allow_hosts
 Type: string
 Default: unix localhost
-_Description: Please enter the name of each host allowed to connect to this server
+_Description: Hosts allowed to connect to this Canna server:

Shorten the synopsis and turn it into a prompt

  Please enter the names of the hosts allowed to connect to this Canna server,
  separated by spaces.
  .
- `unix'  is a special notation for allowing access
- via UNIX domain sockets.
-
+ You can use "unix" to allow access via UNIX domain sockets.

Simplify the sentence

--- canna.old/debian/libcanna1g.templates	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/libcanna1g.templates	2009-03-30 07:34:20.322644118 +0200
@@ -2,19 +2,17 @@
 Type: select
 Choices: verbose, 1.1, 1.2, jdaemin, just, lan5, matsu, skk, tut, unix, vje, wx2+
 Default: verbose
-_Description: Canna input style
- Please choose the default canna input style below, which will be installed if
- there is no previous configuration:
- .
-  verbose - Canna3.5 default style with verbose comments
-  1.1     - old Canna style (ver. 1.1)
-  1.2     - old Canna style (ver. 1.2)
-  jdaemon - jdaemon style
-  just    - Justsystem ATOK like style
-  lan5    - LAN5 like style
-  matsu   - MATSU word processor like style
-  skk     - SKK like style
-  tut     - for TUT-Code
-  unix    - UNIX style
-  vje     - vje like style
-  wx2+    - WX2+ style
+_Description: Canna input style:

Add colon

+ Please choose the default Canna input style:
+  verbose : Canna3.5 default style with verbose comments;
+  1.1     : old Canna style (ver. 1.1);
+  1.2     : old Canna style (ver. 1.2);
+  jdaemon : jdaemon style;
+  just    : Justsystem ATOK like style;
+  lan5    : LAN5 like style;
+  matsu   : MATSU word processor like style;
+  skk     : SKK-like style;
+  tut     : for TUT-Code;
+  unix    : UNIX style;
+  vje     : vje like style;
+  wx2+    : WX2+ style.

Standardize the list of possible choices....

--- canna.old/debian/control	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/control	2009-03-30 07:37:22.130643980 +0200
@@ -11,11 +11,11 @@
 Conflicts: canna-server, libcanna1g (<= 3.5b2-33)
 Replaces: canna-server
 Suggests: canna-shion
-Description: Japanese input system (server and dictionary)
- Canna is a Japanese input system available in Free Software.
- Canna provides a unified user interface for inputting Japanese.
+Description: input system for Japanese - server and dictionary

The important part is that this is an input system...That also avoid
the leading capital.

Standardize on the synopsis format...

+ Canna is a Japanese input system with a
+ unified user interface.

All Debian packages are Free Software, so that mention is not needed
in the context of a Debian package description.

  .
- Canna supports Nemacs, Mule, kinput2 and canuum.  All of these
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
  tools can be used by a single customization file, romaji-to-kana
  conversion rules and conversion dictionaries, and input Japanese in
  the same way.
@@ -23,24 +23,44 @@
  Canna converts kana to kanji based on a client-server model and
  supports automatic kana-to-kanji conversion.
  .
- This package includes the cannaserver program and dictionary files.
+ This package provides the Canna server program and dictionary files.

Even if the server binary name is "cannaserver", we can define it as
"the Canna server".
 
 Package: canna-utils
 Architecture: any
 Depends: ${shlibs:Depends}
 Conflicts: canna (<= 3.5b2-33), libcanna1g (<= 3.5b2-33)
-Description: Japanese input system (utility)
- Canna is a Japanese input system available in Free Software.
- This package includes canna client programs.
+Description: input system for Japanese - utilities
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides Canna client programs.

Add the boilerplate to this package (and all other binary packages).

Similar changes follow...
 
 Package: libcanna1g
 Section: libs
 Architecture: any
 Depends: ${shlibs:Depends}, debconf
 Conflicts: canna (<= 3.5b2-33)
-Description: Canna Runtime Library
- Canna is a Japanese input system available in Free Software.
- This package includes canna shared libraries.
+Description: input system for Japanese - runtime library
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides Canna shared libraries.
 
 Package: libcanna1g-dev
 Section: libdevel
@@ -48,6 +68,17 @@
 Depends: libcanna1g
 Conflicts: canna-dev, libcanna1-dev, canna (<= 3.5b2-23)
 Replaces: canna-dev
-Description: Canna Static Library and Headers
- Canna is a Japanese input system available in Free Software.
- This package includes header and static libraries.
+Description: input system for Japanese - development files
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides header and static libraries, needed to develop
+ software based on Canna.

-- 


Template: canna/run_cannaserver
Type: boolean
Default: true
_Description: Do you want to run the Canna server?
 This package contains the Canna server and server-related
 utilities. If you are only interested in these utilities,
 you can disable the Canna server now.


Template: canna/run_with_inet
Type: boolean
Default: false
_Description: Allow connections to the Canna server from remote hosts?
 The Canna server only allows connections via UNIX domain
 sockets when the "-inet" option is not specified.  This
 means that when the Canna server is started without the "-inet" option,
 only clients which run on the same host can connect to the server.
 Some clients, such as egg and yc-el, do not support
 UNIX domain socket and require the "-inet" option, even if they run on
 the same host.
 .
 You should choose this option if you want to connect to this Canna
 server from remote hosts, or
 if you want to use inet-domain-only software.


Template: canna/manage_allow_hosts_with_debconf
Type: boolean
Default: true
_Description: Manage /etc/hosts.canna automatically?
 The /etc/hosts.canna file lists hosts allowed to connect to the
 Canna server server.
 .
 You should not accept this option if you prefer managing that
 file's content manually.


Template: canna/allow_hosts
Type: string
Default: unix localhost
_Description: Hosts allowed to connect to this Canna server:
 Please enter the names of the hosts allowed to connect to this Canna server,
 separated by spaces.
 .
 You can use "unix" to allow access via UNIX domain sockets.
Template: canna/default_style
Type: select
Choices: verbose, 1.1, 1.2, jdaemin, just, lan5, matsu, skk, tut, unix, vje, wx2+
Default: verbose
_Description: Canna input style:
 Please choose the default Canna input style:
  verbose : Canna3.5 default style with verbose comments;
  1.1     : old Canna style (ver. 1.1);
  1.2     : old Canna style (ver. 1.2);
  jdaemon : jdaemon style;
  just    : Justsystem ATOK like style;
  lan5    : LAN5 like style;
  matsu   : MATSU word processor like style;
  skk     : SKK-like style;
  tut     : for TUT-Code;
  unix    : UNIX style;
  vje     : vje like style;
  wx2+    : WX2+ style.
--- canna.old/debian/templates	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/templates	2009-04-03 08:34:27.971821871 +0200
@@ -1,46 +1,45 @@
 Template: canna/run_cannaserver
 Type: boolean
 Default: true
-_Description: Do you want to run the Canna server ?
+_Description: Do you want to run the Canna server?
  This package contains the Canna server and server-related
  utilities. If you are only interested in these utilities,
- you can disable the Canna server here.
+ you can disable the Canna server now.
 
 
 Template: canna/run_with_inet
 Type: boolean
 Default: false
-_Description: Do you want to connect to the Canna server from a remote host?
+_Description: Allow connections to the Canna server from remote hosts?
  The Canna server only allows connections via UNIX domain
- sockets when the `-inet' option is not specified.  This
- means that when the Canna server is started without the `-inet' option,
+ sockets when the "-inet" option is not specified.  This
+ means that when the Canna server is started without the "-inet" option,
  only clients which run on the same host can connect to the server.
- Some clients such as, `egg' and `yc-el', do not support
- UNIX domain socket and require the `-inet' option, even if they run on
+ Some clients, such as egg and yc-el, do not support
+ UNIX domain socket and require the "-inet" option, even if they run on
  the same host.
  .
- If you want to connect to this Canna server from remote hosts, or
- if you want to use INET-domain-only software, you should run
- the server with the `-inet' option.
+ You should choose this option if you want to connect to this Canna
+ server from remote hosts, or
+ if you want to use inet-domain-only software.
 
 
 Template: canna/manage_allow_hosts_with_debconf
 Type: boolean
 Default: true
-_Description: Manage /etc/hosts.canna with debconf ?
- /etc/hosts.canna controls which hosts can connect to this server.
+_Description: Manage /etc/hosts.canna automatically?
+ The /etc/hosts.canna file lists hosts allowed to connect to the
+ Canna server server.
  .
- By default /etc/hosts.canna will be managed with debconf.
- Refuse here if you want to manage /etc/hosts.canna yourself.
+ You should not accept this option if you prefer managing that
+ file's content manually.
 
 
 Template: canna/allow_hosts
 Type: string
 Default: unix localhost
-_Description: Please enter the name of each host allowed to connect to this server
+_Description: Hosts allowed to connect to this Canna server:
  Please enter the names of the hosts allowed to connect to this Canna server,
  separated by spaces.
  .
- `unix'  is a special notation for allowing access
- via UNIX domain sockets.
-
+ You can use "unix" to allow access via UNIX domain sockets.
--- canna.old/debian/libcanna1g.templates	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/libcanna1g.templates	2009-03-30 07:34:20.322644118 +0200
@@ -2,19 +2,17 @@
 Type: select
 Choices: verbose, 1.1, 1.2, jdaemin, just, lan5, matsu, skk, tut, unix, vje, wx2+
 Default: verbose
-_Description: Canna input style
- Please choose the default canna input style below, which will be installed if
- there is no previous configuration:
- .
-  verbose - Canna3.5 default style with verbose comments
-  1.1     - old Canna style (ver. 1.1)
-  1.2     - old Canna style (ver. 1.2)
-  jdaemon - jdaemon style
-  just    - Justsystem ATOK like style
-  lan5    - LAN5 like style
-  matsu   - MATSU word processor like style
-  skk     - SKK like style
-  tut     - for TUT-Code
-  unix    - UNIX style
-  vje     - vje like style
-  wx2+    - WX2+ style
+_Description: Canna input style:
+ Please choose the default Canna input style:
+  verbose : Canna3.5 default style with verbose comments;
+  1.1     : old Canna style (ver. 1.1);
+  1.2     : old Canna style (ver. 1.2);
+  jdaemon : jdaemon style;
+  just    : Justsystem ATOK like style;
+  lan5    : LAN5 like style;
+  matsu   : MATSU word processor like style;
+  skk     : SKK-like style;
+  tut     : for TUT-Code;
+  unix    : UNIX style;
+  vje     : vje like style;
+  wx2+    : WX2+ style.
--- canna.old/debian/control	2009-02-14 12:20:04.323869668 +0100
+++ canna/debian/control	2009-03-30 07:37:22.130643980 +0200
@@ -11,11 +11,11 @@
 Conflicts: canna-server, libcanna1g (<= 3.5b2-33)
 Replaces: canna-server
 Suggests: canna-shion
-Description: Japanese input system (server and dictionary)
- Canna is a Japanese input system available in Free Software.
- Canna provides a unified user interface for inputting Japanese.
+Description: input system for Japanese - server and dictionary
+ Canna is a Japanese input system with a
+ unified user interface.
  .
- Canna supports Nemacs, Mule, kinput2 and canuum.  All of these
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
  tools can be used by a single customization file, romaji-to-kana
  conversion rules and conversion dictionaries, and input Japanese in
  the same way.
@@ -23,24 +23,44 @@
  Canna converts kana to kanji based on a client-server model and
  supports automatic kana-to-kanji conversion.
  .
- This package includes the cannaserver program and dictionary files.
+ This package provides the Canna server program and dictionary files.
 
 Package: canna-utils
 Architecture: any
 Depends: ${shlibs:Depends}
 Conflicts: canna (<= 3.5b2-33), libcanna1g (<= 3.5b2-33)
-Description: Japanese input system (utility)
- Canna is a Japanese input system available in Free Software.
- This package includes canna client programs.
+Description: input system for Japanese - utilities
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides Canna client programs.
 
 Package: libcanna1g
 Section: libs
 Architecture: any
 Depends: ${shlibs:Depends}, debconf
 Conflicts: canna (<= 3.5b2-33)
-Description: Canna Runtime Library
- Canna is a Japanese input system available in Free Software.
- This package includes canna shared libraries.
+Description: input system for Japanese - runtime library
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides Canna shared libraries.
 
 Package: libcanna1g-dev
 Section: libdevel
@@ -48,6 +68,17 @@
 Depends: libcanna1g
 Conflicts: canna-dev, libcanna1-dev, canna (<= 3.5b2-23)
 Replaces: canna-dev
-Description: Canna Static Library and Headers
- Canna is a Japanese input system available in Free Software.
- This package includes header and static libraries.
+Description: input system for Japanese - development files
+ Canna is a Japanese input system with a
+ unified user interface.
+ .
+ It supports Nemacs, Mule, kinput2 and canuum.  All of these
+ tools can be used by a single customization file, romaji-to-kana
+ conversion rules and conversion dictionaries, and input Japanese in
+ the same way.
+ .
+ Canna converts kana to kanji based on a client-server model and
+ supports automatic kana-to-kanji conversion.
+ .
+ This package provides header and static libraries, needed to develop
+ software based on Canna.
Source: canna
Section: utils
Priority: optional
Maintainer: Atsushi Mitsuka <mitsuka@misao.gr.jp>
Build-Depends: debhelper (>= 4.1.59), libx11-dev, xutils-dev, dpatch, po-debconf, autoconf2.13, ptex-bin
Standards-Version: 3.6.2

Package: canna
Architecture: any
Depends: ${shlibs:Depends}, debconf | debconf-2.0, adduser (>= 3.34)
Conflicts: canna-server, libcanna1g (<= 3.5b2-33)
Replaces: canna-server
Suggests: canna-shion
Description: input system for Japanese - server and dictionary
 Canna is a Japanese input system with a
 unified user interface.
 .
 It supports Nemacs, Mule, kinput2 and canuum.  All of these
 tools can be used by a single customization file, romaji-to-kana
 conversion rules and conversion dictionaries, and input Japanese in
 the same way.
 .
 Canna converts kana to kanji based on a client-server model and
 supports automatic kana-to-kanji conversion.
 .
 This package provides the Canna server program and dictionary files.

Package: canna-utils
Architecture: any
Depends: ${shlibs:Depends}
Conflicts: canna (<= 3.5b2-33), libcanna1g (<= 3.5b2-33)
Description: input system for Japanese - utilities
 Canna is a Japanese input system with a
 unified user interface.
 .
 It supports Nemacs, Mule, kinput2 and canuum.  All of these
 tools can be used by a single customization file, romaji-to-kana
 conversion rules and conversion dictionaries, and input Japanese in
 the same way.
 .
 Canna converts kana to kanji based on a client-server model and
 supports automatic kana-to-kanji conversion.
 .
 This package provides Canna client programs.

Package: libcanna1g
Section: libs
Architecture: any
Depends: ${shlibs:Depends}, debconf
Conflicts: canna (<= 3.5b2-33)
Description: input system for Japanese - runtime library
 Canna is a Japanese input system with a
 unified user interface.
 .
 It supports Nemacs, Mule, kinput2 and canuum.  All of these
 tools can be used by a single customization file, romaji-to-kana
 conversion rules and conversion dictionaries, and input Japanese in
 the same way.
 .
 Canna converts kana to kanji based on a client-server model and
 supports automatic kana-to-kanji conversion.
 .
 This package provides Canna shared libraries.

Package: libcanna1g-dev
Section: libdevel
Architecture: any
Depends: libcanna1g
Conflicts: canna-dev, libcanna1-dev, canna (<= 3.5b2-23)
Replaces: canna-dev
Description: input system for Japanese - development files
 Canna is a Japanese input system with a
 unified user interface.
 .
 It supports Nemacs, Mule, kinput2 and canuum.  All of these
 tools can be used by a single customization file, romaji-to-kana
 conversion rules and conversion dictionaries, and input Japanese in
 the same way.
 .
 Canna converts kana to kanji based on a client-server model and
 supports automatic kana-to-kanji conversion.
 .
 This package provides header and static libraries, needed to develop
 software based on Canna.

Attachment: signature.asc
Description: Digital signature


Reply to: