From owner-svn-doc-all@freebsd.org  Tue Jun 20 11:30:02 2017
Return-Path: <owner-svn-doc-all@freebsd.org>
Delivered-To: svn-doc-all@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 2BBFED962E0;
 Tue, 20 Jun 2017 11:30:02 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id EDA257E057;
 Tue, 20 Jun 2017 11:30:01 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id v5KBU1Q0095449;
 Tue, 20 Jun 2017 11:30:01 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id v5KBU11B095448;
 Tue, 20 Jun 2017 11:30:01 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201706201130.v5KBU11B095448@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Tue, 20 Jun 2017 11:30:01 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r50387 -
 head/en_US.ISO8859-1/books/porters-handbook/quick-porting
X-SVN-Group: doc-head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-all@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "SVN commit messages for the entire doc trees \(except for &quot;
 user&quot; , &quot; projects&quot; , and &quot; translations&quot;
 \)" <svn-doc-all.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-all/>
List-Post: <mailto:svn-doc-all@freebsd.org>
List-Help: <mailto:svn-doc-all-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 20 Jun 2017 11:30:02 -0000

Author: mat
Date: Tue Jun 20 11:30:00 2017
New Revision: 50387
URL: https://svnweb.freebsd.org/changeset/doc/50387

Log:
  Add a second paragraph on what pkg-descr should be.
  
  Sponsored by:	Absolight

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml	Tue Jun 20 11:29:58 2017	(r50386)
+++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml	Tue Jun 20 11:30:00 2017	(r50387)
@@ -101,6 +101,12 @@ COMMENT=	Cat chasing a mouse all over the screen
 	  are in an awkward format.  For example, manpages have
 	  justified spacing, which looks particularly bad with
 	  monospaced fonts.</para>
+
+	<para>On the other hand, the content of
+	  <filename>pkg-descr</filename> must be longer than the <link
+	    linkend="makefile-comment"><varname>COMMENT</varname></link>
+	  line from the Makefile.  It must explain in more depth what
+	  the port is all about.</para>
       </note>
 
       <para>A well-written <filename>pkg-descr</filename> describes