5.6. COMMENT

This is a one-line description of the port. Please respect the following rules:

  1. Try to keep the COMMENT value at no longer than 70 characters, as this line will be used by pkg info (see pkg-info(8)) to display a one-line summary of the port;

  2. Do not include the package name (or version number of the software);

  3. The comment should begin with a capital and end without a period;

  4. Do not start with an indefinite article (i.e., A or An);

  5. Names are capitalized (for example, Apache, JavaScript, Perl);

  6. For lists of words, use the Oxford comma (e.g., green, red, and blue);

  7. Spell check the text.

Here is an example:

COMMENT=	Cat chasing a mouse all over the screen

The COMMENT variable should immediately follow the MAINTAINER variable in the Makefile.

All FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/

Questions that are not answered by the documentation may be sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.