From owner-freebsd-doc@FreeBSD.ORG Thu Dec 16 01:40:08 2010 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id A93F9106566C for ; Thu, 16 Dec 2010 01:40:08 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 587C28FC0C for ; Thu, 16 Dec 2010 01:40:08 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.4/8.14.4) with ESMTP id oBG1e8uY076513 for ; Thu, 16 Dec 2010 01:40:08 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.4/8.14.4/Submit) id oBG1e8ui076512; Thu, 16 Dec 2010 01:40:08 GMT (envelope-from gnats) Resent-Date: Thu, 16 Dec 2010 01:40:08 GMT Resent-Message-Id: <201012160140.oBG1e8ui076512@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Jason Helfman Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id A69241065670 for ; 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 ; 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 ; 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 ; 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 ; 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 To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Cc: Subject: docs/153196: [patch] porters-handbook: port comments are cut after 60 characters, book indicates 70 X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Jason Helfman List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Dec 2010 01:40:08 -0000 >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@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 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 @@ The COMMENT variable should immediately follow the MAINTAINER variable in the Makefile. - Please try to keep the COMMENT line less than 70 + 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. >Release-Note: >Audit-Trail: >Unformatted: