[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Best practice for package synopsis (was: debian/control best practices)

"Carlos Eduardo Sotelo Pinto" <krlos.aqp@gmail.com> writes:

> I understand that ( and one more person say me the same ) that
> synposys must be on lower cases
> http://www.debian.org/doc/developers-reference/best-pkging-practices.html#bpp-pkg-synopsis

More accurately, the synopsis should be written so that it makes sense
in the middle of a sentence.

> package-name is a synopsis.
> but all the packages that I have seen was on this way
> Package-name is a synopsis.

This is the example sentence. Your package description should only
contain the 'synopsis' part as its first line.

That section of the Best Packaging Practices chapter is, to my mind,
confusingly written, though I agree with its advice. I'm working with
others (slowly) on debian-l10n-english@l.d.o to form a better wording.

 \        “I hate it when my foot falls asleep during the day, because |
  `\            that means it's gonna be up all night.” —Steven Wright |
_o__)                                                                  |
Ben Finney

Reply to: