Your message dated Sun, 6 Jul 2008 22:09:03 -0400
with message-id <[EMAIL PROTECTED]>
and subject line Re: Bug#489423: trash-cli: documentation problems
has caused the Debian Bug report #489423,
regarding trash-cli: documentation problems
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [EMAIL PROTECTED]
immediately.)


-- 
489423: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=489423
Debian Bug Tracking System
Contact [EMAIL PROTECTED] with problems
--- Begin Message ---
Package: trash-cli
Version: 0.1.10.28-1
Severity: minor

This package is a classic case of "nice program, a shame about the
documentation".  In particular: 

1) The package description needs work:

# Description: Command line trashcan utility         
#  Command line interface trashcan freedesktop.org specs compliant. For each
#  trashed file remember name, original path, date of deletion, and
#  permissions.
#  .
#  Designed to interoperate with KDE Trash.         

The short description isn't bad (though DevRef says package synopses
should not be capitalised); the long description is gobbledigook.  I
think what you were aiming at was something like:

  Description: command line trashcan utility
   This package provides a command line interface trashcan utility
   compliant with the FreeDesktop.org Trash Specification. It remembers
   the name, original path, deletion date, and permissions of each trashed
   file, and is designed to interoperate with KDE Trash.

(Does that mean it's known _not_ to interoperate with GNOME etc?)

2) All of the man pages are lamentable, too.  What little
        information they provide is badly formatted, badly
        organised, and badly translated into English.  As a random
        example, the "OPTIONS" section for trash(1) says:

# OPTIONS
#       --'trash
#              To remove move foo in the trash can, use $trash foo

Putting this under "OPTIONS" makes no sense; the punctuation before
the word "trash" makes no sense; the pretence that "$trash" is a
variable makes no sense; and the content makes no sense.  It should
be something along the lines of:

  ARGUMENTS
 
  To move the file 'foo' into the trashcan, use 'trash foo'.

3) The docs should prominently feature either a summary of the
        FreeDesktop.org Trash Specification or at least the URL:

  SEE ALSO

  list-trash(1), restore-trash(1), list-trash(1), empty-trash(1),
  and the FreeDesktop.org Trash Specification at
  "http://www.ramendik.ru/docs/trashspec.html";.

4) There's a surplus man page, /usr/share/man/man1/bluetrash.1.gz,
        with no corresponding executable (and no way for users to
        find it).  If the options it lists really exist, they should
        be included in the other man pages.

-- System Information:
Debian Release: lenny/sid
  APT prefers testing
  APT policy: (500, 'testing'), (50, 'unstable')
Architecture: i386 (i586)

Kernel: Linux 2.6.25.custom
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages trash-cli depends on:
ii  python                        2.5.2-1    An interactive high-level object-o
ii  python-support                0.8.1      automated rebuilding support for P

trash-cli recommends no packages.

-- no debconf information
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)



--- End Message ---
--- Begin Message ---
trash-cli (0.1.10.28-2) unstable; urgency=low

  * Removed surplus manpage (Closes: #489423)
     - Removed bluetrash.1 from debian/manpage
     - Edited bluetrash.1 from debian/manpages
  * debian/control: Improved description [thanks to Justin B Rye]
  * Improved manpage descriptions
  * Added SEE ALSO to manpages
  * debian/control: bumped standards version to 3.8.0 (no change)


--- End Message ---

Reply via email to