Craig Small wrote:
> Justin B Rye wrote:
>>  Description: Documentation for #PACKAGE#
>> 
>>  Description: Source for the #PACKAGE# driver.
>> 
>> This use of capitalisation and punctuation is contrary to the
>> recommendations in the Debian Developer's Reference.  In fact on
>> debian-l10n-english we frequently suggest a format more like the
>> following for multi-binary packages: 
>> 
>>  Description: <suite synopsis> - utilities
>>  Description: <suite synopsis> - documentation
>>  Description: <suite synopsis> - source
>> 
>> but while that format's widely used it's not enshrined in policy.
> So...
> It should be
> Description: #PACKAGE# - documentation
> 
> Description: #PACKAGE# - source
> 
> ?
> 
> I'm not quite sure what you want it to be.

The "Documentation for..." and "Source for..." versions are buggy,
so I attached a patch with the minimum fix necessary to make them
compliant with DevRef 6.2.2's recommendations.

Changing them to the "<suite synopsis> - documentation" format might
please me personally, but that would only be a wishlist-level bug,
and it's trickier than just making it "#PACKAGE# - documentation"
because the bare package-name more or less never makes an adequate
"suite synopsis".  The nearest you get is cases like the Courier MTA
suite, with short descriptions like:

 courier-base: Courier mail server - base system
 courier-doc: Courier mail server - additional documentation
 courier-imap: Courier mail server - IMAP server

(These are capitalised because "Courier" here is the name of the
upstream software project rather than of a .deb or executable.)

Besides, not all "multiple binary" source packages suit this style.
If it's multiple only to the extent of having a #PACKAGE# and a
#PACKAGE#-doc, the latter may be better of labelled as
"documentation for #PACKAGE#".

In an ideal world I'd have a pointer to a generally agreed set of
clear, detailed and robust recommendations, and the section of the
New Maintainer's Guide that points at dh-make would also point at
that; but the best we've got is DevRef 6.2.2.
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)



-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to