FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Debian > Debian Development

 
 
LinkBack Thread Tools
 
Old 04-18-2010, 11:48 AM
Frank Lin PIAT
 
Default Package description review (in ITP)

Hi,

A good package description is important, because sysadmin often decide
to install a package (or not), base on it's description.

Shouldn't we suggest/require that the descriptions in ITP bugs includes
the intended description for the package? (as opposed to a mere copy of
upstream description)

If debian-devel readers knew for that the submitted description is the
one intended to be uploaded, they wouldn't hesitate to provide feedback
(spell checking, grammar, lack of context, clarity issues, etc.)


Current ITP look likes this:
> * Package name : test
> Version : x.y.z
> Upstream Author : Name <somebody@example.org>
> * URL : http://www.example.org/
> * License : (GPL, LGPL, BSD, MIT/X, etc.)
> Programming Lang: (C, C++, C#, Perl, Python, etc.)
> Description : test
>
> (Include the long description here.)

I suggest to replace the last line with:

> (Include the intended long description of the package here.)


A few other ressources needs to be changed too:

In http://www.debian.org/devel/wnpp/ :
Before:
> submit a bug report against the pseudo-package wnpp describing your
> plan to create a new package, including, but not limiting yourself to,
> a description of the package, the license of the prospective package,
> and the current URL where it can be downloaded from.
New:
> submit a bug report against the pseudo-package wnpp describing your
> plan to create a new package, including, but not limiting yourself to,
> the intended package description, the license of the prospective
> package, and the current URL where it can be downloaded from.


* http://www.debian.org/doc/developers-reference/pkgs.html
In paragraph «Adding new entries with "reportbug"», replace:
> Below the "Description" line you should give more information about
> the package.
By:
> Below the "Description" line you should write the description you
> intend for the package so other can review it. (If you Request For
> Package, you can just give more information about the package).

Voilŕ,

Franklin


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 1271591288.3364.932.camel@solid.paris.klabs.be">ht tp://lists.debian.org/1271591288.3364.932.camel@solid.paris.klabs.be
 
Old 04-18-2010, 01:42 PM
Ben Finney
 
Default Package description review (in ITP)

Frank Lin PIAT <fpiat@klabs.be> writes:

> Shouldn't we suggest/require that the descriptions in ITP bugs
> includes the intended description for the package? (as opposed to a
> mere copy of upstream description)

This has been mentioned a number of times over the years, and it's still
a good idea IMO.

> Current ITP look likes this:
[…]
> > (Include the long description here.)
>
> I suggest to replace the last line with:
>
> > (Include the intended long description of the package here.)

Perhaps be even more explicit:

(Include the intended long description of the Debian package here.)

> VoilĂ*,
>
> Franklin

Thanks for pursuing this.

--
“Odious ideas are not entitled to hide from criticism behind |
` the human shield of their believers' feelings.” —Richard |
_o__) Stallman |
Ben Finney


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 87k4s4j2r6.fsf@benfinney.id.au">http://lists.debian.org/87k4s4j2r6.fsf@benfinney.id.au
 

Thread Tools




All times are GMT. The time now is 06:33 PM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright ©2007 - 2008, www.linux-archive.org