Bug 153196

Summary: [patch] porters-handbook: port comments are cut after 60 characters, book indicates 70
Product: Documentation Reporter: Jason Helfman <jhelfman>
Component: Books & ArticlesAssignee: Johann Kois <jkois>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Jason Helfman 2010-12-16 01:40:08 UTC
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.
Comment 1 Johann Kois freebsd_committer freebsd_triage 2010-12-17 13:04:31 UTC
Responsible Changed
From-To: freebsd-doc->jkois

Take.
Comment 2 dfilter service freebsd_committer freebsd_triage 2010-12-22 08:28:55 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"
Comment 3 Johann Kois freebsd_committer freebsd_triage 2010-12-24 16:54:50 UTC
State Changed
From-To: open->closed

Committed and now online.  Close this PR.