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

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



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

>  Template: canna/run_cannaserver
[...]
> +_Description: Do you want to run the Canna server?

In principle what I want might not be the deciding factor; and
running it manually is still running it.

   _Description: Should the Canna server run automatically?
 
>  Template: canna/run_with_inet
> +_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.
> 

This explanation is confusing, partly because of the ambiguity of
"only allows foo when bar is not specified".  For a while I thought
that meant network mode didn't support UNIX socket connections at
all, but that doesn't match what "canna/allow_hosts" says.  So
here's a version dumbed down enough for people like me: 

   _Description: Should the Canna server run in network mode?
    By default the Canna server will run without support for network
    connections, and will only accept connections on UNIX domain sockets,
    from clients running on the same host.
    .
    If you choose this option, network support will be activated, and the
    Canna server will accept connections on TCP sockets from clients that
    may be on remote hosts. Some clients (such as egg and yc-el) require
    this mode even if they run on the local host.

>  Template: canna/manage_allow_hosts_with_debconf
[...]
> + 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.

s/that file's content/the file's contents/
  
Template: canna/default_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;

Using colons to separate columns is unconventional in en_US text
(the more normal approach would be either to use dashes or tack each
colon onto the headword in the left-hand column).  It does look neat
in tables like this, so I won't object; but the column can't be
free-floating.

     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;

If this means "a style resembling Justsystem ATOK" (whatever that
is), then it's redundant to use both "like" and "style".  Cutting
"like" throughout also avoids the issue of where to put hyphens.

Apparently it's "JustSystems" (and s/MATSU/Matsu/).  So:

     just   : JustSystems ATOK style;

> Package: canna
[...]
> + Canna is a Japanese input system with a
> + unified user interface.

Well, it's only one thing - of course it's unified!

  Canna provides a unified user interface for Japanese input.

>   .
> - 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.

Only kinput2 is in Debian.  Canuum still seems to exist, but
Nemacs gets me a lot of cobwebby Google hits, including variants of
this text that talk about "Nemacs(Mule)" - which makes me suspect
that Mule and Nemacs never were intended as separate items.  Then 
the rest of that paragraph took me a while to decipher...

>   Canna converts kana to kanji based on a client-server model and
>   supports automatic kana-to-kanji conversion.

This isn't bad, but it's slightly repetitive and slightly misplaced;
we ought to introduce the client/server kanjification part _before_
talking about particular clients and features.  I've appended it to
the opening paragraph, so that the boilerplate section in full is:

    Canna provides a unified user interface for Japanese input. It is based
    on a client-server model and supports automatic kana-to-kanji conversion.
    .
    It supports multiple clients (including kinput2 and canuum), and allows
    them all to work in the same way, sharing customization files,
    romaji-to-kana conversion rules and conversion dictionaries.

>  Package: canna-utils
[...]
> + This package provides Canna client programs.
>
>  Package: libcanna1g
[...]
> + This package provides Canna shared libraries.

"Canna client" is plausible enough, but "Canna shared libraries"
feels awkward, so change both to
                          client programs for Canna.
                          shared libraries for Canna.

>  Package: libcanna1g-dev
[...]
>  This package provides header and static libraries, needed to develop
>  software based on Canna.

Tweaking this slightly:

   This package provides the headers and static libraries needed to develop
   software based on Canna.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../canna-3.7p3.pristine/debian/templates	2009-03-30 20:17:09.000000000 +0100
+++ debian/templates	2009-04-03 16:55:07.000000000 +0100
@@ -1,46 +1,42 @@
 Template: canna/run_cannaserver
 Type: boolean
 Default: true
-_Description: Do you want to run the Canna server ?
+_Description: Should the Canna server run automatically??
  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?
- 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.
+_Description: Should the Canna server run in network mode?         
+ By default the Canna server will run without support for network
+ connections, and will only accept connections on UNIX domain sockets,
+ from clients running 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.
+ If you choose this option, network support will be activated, and the
+ Canna server will accept connections on TCP sockets from clients that
+ may be on remote hosts. Some clients (such as egg and yc-el) require
+ this mode even if they run on the local host.
 
 
 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.
  .
- 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 the
+ file's contents 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-3.7p3.pristine/debian/libcanna1g.templates	2009-03-30 20:17:09.000000000 +0100
+++ debian/libcanna1g.templates	2009-04-03 16:52:41.000000000 +0100
@@ -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   : JustSystems ATOK style;
+  lan5   : LAN5 style;
+  matsu  : Matsu word processor style;
+  skk    : SKK style;
+  tut    : TUT-Code style;
+  unix   : UNIX style;
+  vje    : vje style;
+  wx2+   : WX2+ style.
--- ../canna-3.7p3.pristine/debian/control	2009-03-30 20:17:09.000000000 +0100
+++ debian/control	2009-04-03 17:55:39.000000000 +0100
@@ -11,36 +11,44 @@
 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.
- .
- Canna 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.
+Description: input system for Japanese - server and dictionary
+ Canna provides a unified user interface for Japanese input. It is based
+ on a client-server model and supports automatic kana-to-kanji conversion.
  .
- Canna converts kana to kanji based on a client-server model and
- supports automatic kana-to-kanji conversion.
+ It supports multiple clients (including kinput2 and canuum), and allows
+ them all to work in the same way, sharing customization files,
+ romaji-to-kana conversion rules and conversion dictionaries.
  .
- 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 provides a unified user interface for Japanese input. It is based
+ on a client-server model and supports automatic kana-to-kanji conversion.
+ .
+ It supports multiple clients (including kinput2 and canuum), and allows
+ them all to work in the same way, sharing customization files,
+ romaji-to-kana conversion rules and conversion dictionaries.
+ .
+ This package provides client programs for Canna.
 
 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 provides a unified user interface for Japanese input. It is based
+ on a client-server model and supports automatic kana-to-kanji conversion.
+ .
+ It supports multiple clients (including kinput2 and canuum), and allows
+ them all to work in the same way, sharing customization files,
+ romaji-to-kana conversion rules and conversion dictionaries.
+ .
+ This package provides shared libraries for Canna.
 
 Package: libcanna1g-dev
 Section: libdevel
@@ -48,6 +56,13 @@
 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 provides a unified user interface for Japanese input. It is based
+ on a client-server model and supports automatic kana-to-kanji conversion.
+ .
+ It supports multiple clients (including kinput2 and canuum), and allows
+ them all to work in the same way, sharing customization files,
+ romaji-to-kana conversion rules and conversion dictionaries.
+ .
+ This package provides the headers and static libraries needed to develop
+ software based on Canna.
Template: canna/run_cannaserver
Type: boolean
Default: true
_Description: Should the Canna server run automatically??
 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: Should the Canna server run in network mode?         
 By default the Canna server will run without support for network
 connections, and will only accept connections on UNIX domain sockets,
 from clients running on the same host.
 .
 If you choose this option, network support will be activated, and the
 Canna server will accept connections on TCP sockets from clients that
 may be on remote hosts. Some clients (such as egg and yc-el) require
 this mode even if they run on the local host.


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.
 .
 You should not accept this option if you prefer managing the
 file's contents 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   : JustSystems ATOK style;
  lan5   : LAN5 style;
  matsu  : Matsu word processor style;
  skk    : SKK style;
  tut    : TUT-Code style;
  unix   : UNIX style;
  vje    : vje style;
  wx2+   : WX2+ style.
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 provides a unified user interface for Japanese input. It is based
 on a client-server model and supports automatic kana-to-kanji conversion.
 .
 It supports multiple clients (including kinput2 and canuum), and allows
 them all to work in the same way, sharing customization files,
 romaji-to-kana conversion rules and conversion dictionaries.
 .
 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 provides a unified user interface for Japanese input. It is based
 on a client-server model and supports automatic kana-to-kanji conversion.
 .
 It supports multiple clients (including kinput2 and canuum), and allows
 them all to work in the same way, sharing customization files,
 romaji-to-kana conversion rules and conversion dictionaries.
 .
 This package provides client programs for Canna.

Package: libcanna1g
Section: libs
Architecture: any
Depends: ${shlibs:Depends}, debconf
Conflicts: canna (<= 3.5b2-33)
Description: input system for Japanese - runtime library
 Canna provides a unified user interface for Japanese input. It is based
 on a client-server model and supports automatic kana-to-kanji conversion.
 .
 It supports multiple clients (including kinput2 and canuum), and allows
 them all to work in the same way, sharing customization files,
 romaji-to-kana conversion rules and conversion dictionaries.
 .
 This package provides shared libraries for Canna.

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 provides a unified user interface for Japanese input. It is based
 on a client-server model and supports automatic kana-to-kanji conversion.
 .
 It supports multiple clients (including kinput2 and canuum), and allows
 them all to work in the same way, sharing customization files,
 romaji-to-kana conversion rules and conversion dictionaries.
 .
 This package provides the headers and static libraries needed to develop
 software based on Canna.

Reply to: