docs/153196: [patch] porters-handbook: port comments are cut after 60 characters, book indicates 70

Jason Helfman jhelfman at experts-exchange.com
Thu Dec 16 01:40:08 UTC 2010


>Number:         153196
>Category:       docs
>Synopsis:       [patch] porters-handbook: port comments are cut after 60 characters, book indicates 70
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Dec 16 01:40:08 UTC 2010
>Closed-Date:
>Last-Modified:
>Originator:     Jason Helfman
>Release:        FreeBSD 8.1-RELEASE i386
>Organization:
Experts Exchange, LLC.
>Environment:
System: FreeBSD eggman.experts-exchange.com 8.1-RELEASE FreeBSD 8.1-RELEASE #0: Mon Jul 19 02:55:53 UTC 2010 root at almeida.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC i386


	
>Description:
Porters Handbook indicates that keeping COMMENT line to 70 characters or less is recommended. I found that the limit is 60 to display on command line.

Test port:

PORTNAME=       test
PORTVERSION=    1
COMMENT= Samba provides seamless file and print services to SMB/CIFS clients.
CATEGORIES=	www
MASTER_SITES=   # empty
DISTFILES=      # empty
NO_BUILD=       yes
NO_WRKSUBDIR=   yes

do-install:
	${DO_NADA}

.include <bsd.port.mk>

pkg_info |grep test
test-1              Samba provides seamless file and print services to SMB/CIFS

$ echo "Samba provides seamless file and print services to SMB/CIFS" |wc
       1       9      60

$ echo "Samba provides seamless file and print services to SMB/CIFS clients." |wc 
       1      10      69


>How-To-Repeat:
Use test port from above, run pkg_info and grep for port. Do word count on COMMENT from pkg_info display.
>Fix:

--- porters-handbook/book.sgml.orig	2010-12-15 17:22:25.000000000 -0800
+++ porters-handbook/book.sgml	2010-12-15 17:22:57.000000000 -0800
@@ -3188,7 +3188,7 @@
 	<para>The COMMENT variable should immediately follow the MAINTAINER
 	  variable in the <filename>Makefile</filename>.</para>
 
-	<para>Please try to keep the COMMENT line less than 70
+	<para>Please try to keep the COMMENT line less than 60
 	  characters, as it is displayed to users as a one-line
 	  summary of the port.</para>
       </sect1>
>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list