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

Re: [RFR] Description of new tcltrf package



Sergei Golovan wrote:
> I'm preparing new tcltrf package for Debian and asking someone to
> review its description.

My I-Am-Not-A-Tcl-Programmer warning still applies, of course.

> Package: tcltrf
...
> Description: Tcl data transformations library (runtime)

Should this be:
  Description: Tcl data transformations - runtime library
And
  Description: Tcl data transformations - development files         
...or am I garbling it?

> This package contains an extension to Tcl, which provides various

Again s/, which/which/ before a definition.

When you talk about "this package", do you really mean the Trf
library?

> data transformations. The collection of provided transformation
> procedures includes:
>  * generation of message digests (hash values, checksums): MD2,
>    MD5, SHA/SHS, SHA-1, HAVAL, RIPEMD-128, -160, CRC (polynomial
>    used by PGP), ADLER (based upon zlib);

Google says it's an "Adler" hash rather than an "ADLER" hash.
Unless this is capitalised for some reason specific to Tcl?

>  * conversion from and to various data encodings: dual, octal,
>    hexadecimal representation, uuencoding, base64-encoding,
>    ASCII85-encoding;

"Conversion to and from" is more idiomatic.  "Dual" is "binary"; and
I'll shuffle the order slightly.

>  * a Reed-Solomon error correcting coder;

Google doesn't believe in this expression, but I'm not sure what's
correct.  Maybe "an error-correcting Reed-Solomon encoder/decoder"?

>  * compression/decompression based on zlib and libbz2.
>
> This package contains runtime library to be used in Tcl programs.
> .
> Homepage: http://tcltrf.sourceforge.net/

Modified as in memchan.
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)
--- tcltrf.old	2007-05-30 15:03:53.000000000 +0100
+++ tcltrf.jbr	2007-05-30 15:24:19.000000000 +0100
@@ -3,42 +3,42 @@
 Architecture: any
 Section: libs
 Depends: ${shlibs:Depends}, ${misc:Depends}, tcl8.4 | tclsh
-Description: Tcl data transformations library (runtime)
- This package contains an extension to Tcl, which provides various
+Description: Tcl data transformations - runtime library
+ This package contains an extension to Tcl which provides various
  data transformations. The collection of provided transformation
  procedures includes:
   * generation of message digests (hash values, checksums): MD2,
     MD5, SHA/SHS, SHA-1, HAVAL, RIPEMD-128, -160, CRC (polynomial
-    used by PGP), ADLER (based upon zlib);
-  * conversion from and to various data encodings: dual, octal,
-    hexadecimal representation, uuencoding, base64-encoding,
-    ASCII85-encoding;
-  * a Reed-Solomon error correcting coder;
+    used by PGP), Adler (based upon zlib);
+  * conversion to and from various data encodings: uuencoding,
+    base64-encoding, or ASCII85-encoding, and binary, octal, or
+    hexadecimal representation;
+  * an error-correcting Reed-Solomon encoder/decoder;
   * compression/decompression based on zlib and libbz2.
  .
- This package contains runtime library to be used in Tcl programs.
+ This package contains the runtime library to be used in Tcl programs.
  .
- Homepage: http://tcltrf.sourceforge.net/
+  Homepage: http://tcltrf.sourceforge.net/
 
 Package: tcltrf-dev
 Architecture: any
 Section: libdevel
 Depends: tcltrf (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
-Description: Tcl data transformations library (development files)
- This package contains an extension to Tcl, which provides various
+Description: Tcl data transformations - development files
+ This package contains an extension to Tcl which provides various
  data transformations. The collection of provided transformation
  procedures includes:
   * generation of message digests (hash values, checksums): MD2,
     MD5, SHA/SHS, SHA-1, HAVAL, RIPEMD-128, -160, CRC (polynomial
-    used by PGP), ADLER (based upon zlib);
-  * conversion from and to various data encodings: dual, octal,
-    hexadecimal representation, uuencoding, base64-encoding,
-    ASCII85-encoding;
-  * a Reed-Solomon error correcting coder;
+    used by PGP), Adler (based upon zlib);
+  * conversion to and from various data encodings: uuencoding,
+    base64-encoding, or ASCII85-encoding, and binary, octal, or
+    hexadecimal representation;
+  * an error-correcting Reed-Solomon encoder/decoder;
   * compression/decompression based on zlib and libbz2.
  .
- This package contains files to be used for development of C-based extensions,
- which use Trf library.
+ This package contains files to be used for development of C-based
+ extensions which use the Trf library.
  .
- Homepage: http://tcltrf.sourceforge.net/
+  Homepage: http://tcltrf.sourceforge.net/
 ---------------------------------------------------------------------------------
---------------------------------------------------------------------------------
Package: tcltrf
Architecture: any
Section: libs
Depends: ${shlibs:Depends}, ${misc:Depends}, tcl8.4 | tclsh
Description: Tcl data transformations - runtime library
 This package contains an extension to Tcl which provides various
 data transformations. The collection of provided transformation
 procedures includes:
  * generation of message digests (hash values, checksums): MD2,
    MD5, SHA/SHS, SHA-1, HAVAL, RIPEMD-128, -160, CRC (polynomial
    used by PGP), Adler (based upon zlib);
  * conversion to and from various data encodings: uuencoding,
    base64-encoding, or ASCII85-encoding, and binary, octal, or
    hexadecimal representation;
  * an error-correcting Reed-Solomon encoder/decoder;
  * compression/decompression based on zlib and libbz2.
 .
 This package contains the runtime library to be used in Tcl programs.
 .
  Homepage: http://tcltrf.sourceforge.net/

Package: tcltrf-dev
Architecture: any
Section: libdevel
Depends: tcltrf (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
Description: Tcl data transformations - development files
 This package contains an extension to Tcl which provides various
 data transformations. The collection of provided transformation
 procedures includes:
  * generation of message digests (hash values, checksums): MD2,
    MD5, SHA/SHS, SHA-1, HAVAL, RIPEMD-128, -160, CRC (polynomial
    used by PGP), Adler (based upon zlib);
  * conversion to and from various data encodings: uuencoding,
    base64-encoding, or ASCII85-encoding, and binary, octal, or
    hexadecimal representation;
  * an error-correcting Reed-Solomon encoder/decoder;
  * compression/decompression based on zlib and libbz2.
 .
 This package contains files to be used for development of C-based
 extensions which use the Trf library.
 .
  Homepage: http://tcltrf.sourceforge.net/
---------------------------------------------------------------------------------

Reply to: