[Pkg-xen-devel] Bug#644125: Bug#644125: xenstore-utils has completely inadequate description

[Thomas Goirand]

On 10/03/2011 11:01 AM, Craig Sanders wrote:
> Package: xenstore-utils
> Version: 4.0.1-2
> 
> all it says is:
> 
> "Description: Xenstore utilities for Xen
>  This package contains the Xenstore utilities."
> 
> Wow, i never would have guessed that a package called xenstore-utils
> might contain Xenstore utilities.  I'm glad that's cleared up!
> 
> that just leaves a few tiny, niggling questions:
> 
>  1. WTF are the Xenstore utilities?
>  2. What are they for?
>  2. How do i know if/when i need them installed?
>  3. Are they for installation on the Dom0 host or the DomU guest? 
> 
> 
> 
> The purpose of the Description field in a package is to tell someone,
> particularly someone who has never encountered the package before, what
> the package does.  Re-iterating the package name in slightly longer form
> complete fails in this purpose.
> 
> it is a description which is completely accurate, yet at the same time
> completely and utterly useless.
> 
> if you can't come up with a one or two paragraph summary yourself,
> please at least cut-and-paste some minimally descriptive info from
> the readme, install notes, web page, or whatever other relevant
> documentation or info actually *describes* what the xenstore-utils do.
> 
> it doesn't need to be much.  just a paragraph or two will do.
> 
> craig

Craig,

Because I agree with you, at the end of August, I sent a patch to the
pkg-dev list in the hope of making it better:

http://lists.alioth.debian.org/pipermail/pkg-xen-devel/2011-August/003531.html

But nobody told me if it was ok to commit, if it would be accepted,
rejected, if I should NMU the change, or whatever.

Please read my proposed change, and voice your opinion (or even better,
modify and enhance my patch).

Thomas