[pkg] brutespray - review

[Lukas Schwaighofer]

On Fri, 21 Jul 2017 18:50:01 +0200
Stéphane Neveu <stefneveu at gmail.com> wrote:

> All done... tell me if it looks better to you now. I still need to
> enhance the manpage !

Looks good, two more things:
* debian/control: Priority standard is too high (that's basically a
  statement, that you expect this package to be installed on a "normal"
  installation). It should probably be either optional or extra (I do
  lean towards extra).  Check the Debian Policy [1] for an explanation.
* You should add
      Forwarded: not-needed
  to the DEP-3 header of wordlist.patch to make it clear that this is
  not an upstream bug but a Debian specific change we needed to make.


Suggestions for the man page:
* only put the program invocation "template" into the SYNOPSIS section,
  then start the DESCRIPTION section
* Put what you have in your "header" line into the DESCRIPTION section,
  instead make the "header" line shorter
  DESCRIPTION
  section
  - the "long" description from the header should be put there
  - write something even shorter and more concise as header
* for formatting the options, see ronn-format(7), section DEFINITIONS
  LIST
* include an nmap command in your EXAMPLES section that generates a
  suitable output for brutespray
* in SEE ALSO should probably also put nmap(1)

See for example ls(1) for what I think the SYNOPSIS and DESCRIPTION
sections could look like.

Regards
Lukas

PS: I just noticed that we also uploaded curvedns with a priority
    standard, that should also be corrected to optional or extra with a
    subsequent upload.

[1] https://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-security-team/attachments/20170721/ec2ae4ae/attachment.sig>