From jhelfman@experts-exchange.com  Thu Dec 16 01:37:12 2010
Return-Path: <jhelfman@experts-exchange.com>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id A69241065670
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 16 Dec 2010 01:37:12 +0000 (UTC)
	(envelope-from jhelfman@experts-exchange.com)
Received: from mail.experts-exchange.com (mail.experts-exchange.com [72.29.183.251])
	by mx1.freebsd.org (Postfix) with ESMTP id 851358FC16
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 16 Dec 2010 01:37:12 +0000 (UTC)
Received: from mail.experts-exchange.com (localhost [127.0.0.1])
	by mail.experts-exchange.com (Postfix) with ESMTP id 299CE9C56E3
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 15 Dec 2010 17:37:12 -0800 (PST)
Received: from mail.experts-exchange.com ([127.0.0.1])
	by mail.experts-exchange.com (mail.experts-exchange.com [127.0.0.1]) (amavisd-new, port 10024)
	with ESMTP id 4oun9Dnr7+cO for <FreeBSD-gnats-submit@freebsd.org>;
	Wed, 15 Dec 2010 17:37:12 -0800 (PST)
Received: from experts-exchange.com (unknown [192.168.103.122])
	by mail.experts-exchange.com (Postfix) with SMTP id D4B5B9C56E9
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 15 Dec 2010 17:37:11 -0800 (PST)
Received: (nullmailer pid 97586 invoked by uid 1001);
	Thu, 16 Dec 2010 01:34:09 -0000
Message-Id: <1292463249.590630.97585.nullmailer@experts-exchange.com>
Date: Wed, 15 Dec 2010 17:34:09 -0800
From: Jason Helfman <jhelfman@experts-exchange.com>
Reply-To: Jason Helfman <jhelfman@experts-exchange.com>
To: FreeBSD-gnats-submit@freebsd.org
Subject: [patch] porters-handbook: port comments are cut after 60 characters, book indicates 70
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>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:    jkois
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Dec 16 01:40:08 UTC 2010
>Closed-Date:    Fri Dec 24 16:55:39 UTC 2010
>Last-Modified:  Fri Dec 24 16:55:39 UTC 2010
>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@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:
Responsible-Changed-From-To: freebsd-doc->jkois 
Responsible-Changed-By: jkois 
Responsible-Changed-When: Fri Dec 17 13:04:31 UTC 2010 
Responsible-Changed-Why:  
Take. 


http://www.freebsd.org/cgi/query-pr.cgi?pr=153196 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/153196: commit references a PR
Date: Wed, 22 Dec 2010 08:28:55 +0000 (UTC)

 jkois       2010-12-22 08:28:51 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/porters-handbook book.sgml 
   Log:
   PR:     docs/153196
   
   "pkg_info" uses the content of the "COMMENT" variable in a ports Makefile to display a one-line summary of the port.  But it will only
   display 60 characters (longer COMMENTs are just cut off).
   
   Noted by:       Jason Helfman (jhelfman ett experts-exchange dott com)
   
   Revision  Changes    Path
   1.1090    +3 -3      doc/en_US.ISO8859-1/books/porters-handbook/book.sgml
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->closed 
State-Changed-By: jkois 
State-Changed-When: Fri Dec 24 16:54:50 UTC 2010 
State-Changed-Why:  
Committed and now online.  Close this PR. 


http://www.freebsd.org/cgi/query-pr.cgi?pr=153196 
>Unformatted:
