From owner-svn-src-head@freebsd.org  Wed Apr 19 18:11:09 2017
Return-Path: <owner-svn-src-head@freebsd.org>
Delivered-To: svn-src-head@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 B93DED443DE;
 Wed, 19 Apr 2017 18:11:09 +0000 (UTC)
 (envelope-from emaste@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 88BA2C83;
 Wed, 19 Apr 2017 18:11:09 +0000 (UTC)
 (envelope-from emaste@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id v3JIB8NN030852;
 Wed, 19 Apr 2017 18:11:08 GMT (envelope-from emaste@FreeBSD.org)
Received: (from emaste@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id v3JIB8NS030851;
 Wed, 19 Apr 2017 18:11:08 GMT (envelope-from emaste@FreeBSD.org)
Message-Id: <201704191811.v3JIB8NS030851@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: emaste set sender to
 emaste@FreeBSD.org using -f
From: Ed Maste <emaste@FreeBSD.org>
Date: Wed, 19 Apr 2017 18:11:08 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r317156 - head/tools/build/options
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-head@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: SVN commit messages for the src tree for head/-current
 <svn-src-head.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-head/>
List-Post: <mailto:svn-src-head@freebsd.org>
List-Help: <mailto:svn-src-head-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 19 Apr 2017 18:11:09 -0000

Author: emaste
Date: Wed Apr 19 18:11:08 2017
New Revision: 317156
URL: https://svnweb.freebsd.org/changeset/base/317156

Log:
  makeman: add a comment describing purpose and invocation
  
  Reviewed by:	jhb, ngie
  MFC after:	2 weeks
  Sponsored by:	The FreeBSD Foundation
  Differential Revision:	https://reviews.freebsd.org/D10389

Modified:
  head/tools/build/options/makeman

Modified: head/tools/build/options/makeman
==============================================================================
--- head/tools/build/options/makeman	Wed Apr 19 18:01:53 2017	(r317155)
+++ head/tools/build/options/makeman	Wed Apr 19 18:11:08 2017	(r317156)
@@ -1,8 +1,22 @@
 #!/bin/sh
 #
 # This file is in the public domain.
-#
 # $FreeBSD$
+#
+# This script is used to create the src.conf.5 man page, using template text
+# contained herein and the contents of the WITH_* and WITHOUT_* files in the
+# same directory. Each WITH_* and WITHOUT_* file documents the effect of the
+# /etc/src.conf knob with the same name.
+#
+# This script invokes "make showconfig" for each supported architecture in
+# order to determine, for each option, whether the default setting is always
+# WITH, always WITHOUT, or is architecture-dependent. It also determines
+# and describes dependencies between options.
+#
+# Usage:
+#
+#     cd tools/build/options
+#     sh makeman > ../../../share/man/man5/src.conf.5
 
 set -o errexit
 export LC_ALL=C
@@ -128,7 +142,7 @@ main()
 
 	fbsdid='$'FreeBSD'$'
 	cat <<EOF
-.\" DO NOT EDIT-- this file is automatically generated.
+.\" DO NOT EDIT-- this file is generated by tools/build/options/makeman.
 .\" ${fbsdid}
 .Dd $(echo $(LC_TIME=C date +'%B %e, %Y'))
 .Dt SRC.CONF 5