Date: Thu, 16 Jul 2020 23:05:19 +0000 (UTC) From: John-Mark Gurney <jmg@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r363265 - in head/tools/tools: . man Message-ID: <202007162305.06GN5JUS077012@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: jmg Date: Thu Jul 16 23:05:18 2020 New Revision: 363265 URL: https://svnweb.freebsd.org/changeset/base/363265 Log: add script to help figure out what man pages need MLINKS updated... Added: head/tools/tools/man/ head/tools/tools/man/README (contents, props changed) head/tools/tools/man/checkmlinks.sh (contents, props changed) Modified: head/tools/tools/README Modified: head/tools/tools/README ============================================================================== --- head/tools/tools/README Thu Jul 16 22:01:01 2020 (r363264) +++ head/tools/tools/README Thu Jul 16 23:05:18 2020 (r363265) @@ -44,6 +44,7 @@ kernelcruft Shellscript to find orphaned *.c files in kerninclude Shellscript to find unused #includes in the kernel. kernxref Shellscript to cross reference symbols in the LINT kernel. kttcp An in-kernel version of the ttcp network performance tool +man Scripts useful for working on man pages. mctest A multicast test program mid Create a Message-ID database for mailing lists. mwl Tools specific to the Marvell 88W8363 support Added: head/tools/tools/man/README ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/tools/tools/man/README Thu Jul 16 23:05:18 2020 (r363265) @@ -0,0 +1,23 @@ +man scripts +=========== + +checkmlinks.sh +-------------- + +This is a simple script used to check if a man page's Nm/Fo/Fn macro +names are in the Makefile. + +To run, switch to the directory with the pages in it and run the script: +``` +cd /usr/src/share/man/man9 +sh /usr/src/tools/tools/man/checkmlinks.sh +``` + +The script will output the name that is missing, and the file that it +was sourced from. + +There are a number of exceptions, and those should be added to the +script to skip over, e.g. `SDT_PROBE`. The last one is added because +adding the numbered args is a bit redundant. + +$FreeBSD$ Added: head/tools/tools/man/checkmlinks.sh ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/tools/tools/man/checkmlinks.sh Thu Jul 16 23:05:18 2020 (r363265) @@ -0,0 +1,35 @@ +#!/bin/sh - +# Copyright 2020 John-Mark Gurney. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# $FreeBSD$ +# + +for i in *.[0-9]*; do + for j in $(awk '($1 == ".Nm" || $1 == ".Fo" || $1 == ".Fn") && $2 != "" && $2 != "." && $2 != "," { print $2 }' "$i" | egrep -v 'SDT_PROBE|_Static_assert|ffs_vget|atomic_'); do + if ! grep "$j" Makefile >/dev/null; then + echo missing "$j" from "$i" + fi + done | sort -u +done
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202007162305.06GN5JUS077012>