Re: Please review package description of dctrl2xml
Frank S. Thomas wrote:
> Could someone please review the package description of my recently ITP'ed
> dctrl2xml tool:
Looks pretty good.
>> Description: convert Debian control data to XML
No, short descriptions should say what it is, not what it does.
Description: Debian control data to XML converter
(If it would also be useful in Ubuntu, maybe we need a more generic
word for the Debian-standard control file format. Or maybe Ubuntu
users just need to learn where their OS's package-management system
Otherwise, I can only see stylistic nitpicks:
>> This package contains the dctrl2xml tool that converts Debian control
>> data into an XML representation. It can be used to convert data which
>> is normally found in debian/control, .changes, .dsc, Packages,
>> Sources, and similar files to XML.
>> For most fields dctrl2xml just uses the field name as element name
>> and the field data as element content. For other fields like package
>> interrelationship fields (Depends, Build-Depends, etc.) or the Files
>> field in .changes or Sources files dctrl2xml additionally parses their
>> field data to represent it in a more fine structured form.
I'd prefer s/like/such as/ and some stronger punctuation:
and the field data as element content. For other fields, such as package
interrelationship fields (Depends, Build-Depends, etc.) or the Files
field in .changes or Sources files, dctrl2xml additionally parses their
field data to represent it in a more fine-structured form.
Also an extra hyphen: -----------------------'
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package