makeman: don't copy $FreeBSD$ tags from source files into output

Copying the source VCS ID from WITH_/WITHOUT_* into the generated
src.conf.5 is not necessary, as it is generally possible to determine
the same information using the VCS to examine commit metadata. The
individual source files also match the name of the option recorded in
the generated file, so it is clear from where the content originated.

The copied IDs generate extraneous, non-content noise in the generated
src.conf.5 in some cases, including the first time the file is generated
on a stable branch. In addition, the source file $FreeBSD$ tags are not
expanded by git or other non-Subversion VCSs, which means that makeman
previously could not be used in a non-Subversion working tree.

I accept that there's some desire to keep these, but on balance believe
there is more benefit in removing them.

Reviewed by:	imp, ngie
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D7997
This commit is contained in:
emaste 2017-04-11 17:01:20 +00:00
parent b1948c8fe5
commit 970a57e6ca

View File

@ -1,12 +1,12 @@
#!/bin/sh
#
# This file is in the public domain.
#
# $FreeBSD$
set -o errexit
export LC_ALL=C
ident='$FreeBSD$'
t=$(mktemp -d -t makeman)
trap 'test -d $t && rm -rf $t' exit
@ -126,12 +126,9 @@ main()
{
echo "building src.conf.5 man page from files in ${PWD}" >&2
ident=${ident#$}
ident=${ident% $}
fbsdid='$'FreeBSD'$'
cat <<EOF
.\" DO NOT EDIT-- this file is automatically generated.
.\" from ${ident}
.\" ${fbsdid}
.Dd $(echo $(LC_TIME=C date +'%B %e, %Y'))
.Dt SRC.CONF 5
@ -244,7 +241,7 @@ EOF
fi
echo ".It Va ${opt}"
sed -e's/\$\(FreeBSD: .*\) \$/from \1/' ${opt}
sed -e'/\$FreeBSD.*\$/d' ${opt}
if [ -n "${targets}" ] ; then
echo '.Pp'
echo 'This is a default setting on'