[src/trunk]: src/share/man/man9 portfeatures(9): the man page for the __HAVE ...

[uwe <uwe%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/704244e94c23
branches:  trunk
changeset: 373845:704244e94c23
user:      uwe <uwe%NetBSD.org@localhost>
date:      Mon Mar 06 00:49:31 2023 +0000

description:
portfeatures(9): the man page for the __HAVE macros

The man page itself is a skeleton/template for now.  Please add short
descriptions and xrefs.  If the target man page doesn't yet document
relevant __HAVE macros (hi, mutex(9)), please add something there,
possibly in a .Sh IMPLEMENTATION NOTES section.

diffstat:

 distrib/sets/lists/comp/mi    |   5 ++-
 share/man/man9/Makefile       |   6 +-
 share/man/man9/portfeatures.9 |  78 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 85 insertions(+), 4 deletions(-)

diffs (135 lines):

diff -r a58e7bdc7788 -r 704244e94c23 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Sun Mar 05 23:28:54 2023 +0000
+++ b/distrib/sets/lists/comp/mi        Mon Mar 06 00:49:31 2023 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.2425 2022/10/28 05:23:09 ozaki-r Exp $
+#      $NetBSD: mi,v 1.2426 2023/03/06 00:49:31 uwe Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 ./etc/mtree/set.comp                           comp-sys-root
@@ -12350,6 +12350,7 @@
 ./usr/share/man/cat9/pool_sethardlimit.0       comp-sys-catman         .cat
 ./usr/share/man/cat9/pool_sethiwat.0           comp-sys-catman         .cat
 ./usr/share/man/cat9/pool_setlowat.0           comp-sys-catman         .cat
+./usr/share/man/cat9/portfeatures.0            comp-sys-catman         .cat
 ./usr/share/man/cat9/postsig.0                 comp-sys-catman         .cat
 ./usr/share/man/cat9/powerhook_disestablish.0  comp-sys-catman         .cat
 ./usr/share/man/cat9/powerhook_establish.0     comp-sys-catman         .cat
@@ -20581,6 +20582,7 @@
 ./usr/share/man/html9/pool_sethardlimit.html   comp-sys-htmlman        html
 ./usr/share/man/html9/pool_sethiwat.html       comp-sys-htmlman        html
 ./usr/share/man/html9/pool_setlowat.html       comp-sys-htmlman        html
+./usr/share/man/html9/portfeatures.html                comp-sys-htmlman        html
 ./usr/share/man/html9/postsig.html             comp-sys-htmlman        html
 ./usr/share/man/html9/powerhook_disestablish.html      comp-sys-htmlman        html
 ./usr/share/man/html9/powerhook_establish.html comp-sys-htmlman        html
@@ -28973,6 +28975,7 @@
 ./usr/share/man/man9/pool_sethardlimit.9       comp-sys-man            .man
 ./usr/share/man/man9/pool_sethiwat.9           comp-sys-man            .man
 ./usr/share/man/man9/pool_setlowat.9           comp-sys-man            .man
+./usr/share/man/man9/portfeatures.9            comp-sys-man            .man
 ./usr/share/man/man9/postsig.9                 comp-sys-man            .man
 ./usr/share/man/man9/powerhook_disestablish.9  comp-sys-man            .man
 ./usr/share/man/man9/powerhook_establish.9     comp-sys-man            .man
diff -r a58e7bdc7788 -r 704244e94c23 share/man/man9/Makefile
--- a/share/man/man9/Makefile   Sun Mar 05 23:28:54 2023 +0000
+++ b/share/man/man9/Makefile   Mon Mar 06 00:49:31 2023 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.465 2022/09/04 21:37:50 thorpej Exp $
+#       $NetBSD: Makefile,v 1.466 2023/03/06 00:49:31 uwe Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -44,8 +44,8 @@
        panic.9 pathbuf.9 pci.9 pci_configure_bus.9 pci_intr.9 \
        pci_msi.9 pckbport.9 pcmcia.9 pcq.9 pcu.9 \
        percpu.9 pfil.9 physio.9 pktqueue.9 pmap.9 pmatch.9 pmf.9 pool.9 \
-       pool_cache.9 powerhook_establish.9 ppsratecheck.9 preempt.9 \
-       proc_find.9 pserialize.9 pslist.9 psref.9 putter.9 \
+       pool_cache.9 portfeatures.9 powerhook_establish.9 ppsratecheck.9 \
+       preempt.9 proc_find.9 pserialize.9 pslist.9 psref.9 putter.9 \
        radio.9 ras.9 rasops.9 ratecheck.9 resettodr.9 rnd.9 \
        roundup.9 rssadapt.9 rt_timer.9 rwlock.9 RUN_ONCE.9 STACK.9 \
        scanc.9 \
diff -r a58e7bdc7788 -r 704244e94c23 share/man/man9/portfeatures.9
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man9/portfeatures.9     Mon Mar 06 00:49:31 2023 +0000
@@ -0,0 +1,78 @@
+.\"    $NetBSD: portfeatures.9,v 1.1 2023/03/06 00:49:31 uwe Exp $
+.\"
+.\" Copyright (c) The NetBSD Foundation, Inc.
+.\" 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 ``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 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.
+.Dd March 6, 2023
+.Dt PORTFEATURES 9
+.Os
+.
+.Sh NAME
+.Nm portfeatures
+.Nd the __HAVEs (\|and the have nots\|)
+.
+.Sh DESCRIPTION
+Machine-independent kernel code adapts to differeces in hardware
+capabilities provided by the machine-dependent parts of the kernel.
+A port declares its capabilities by definining various
+.Li __HAVE_ Ns Ar feature
+macros.
+This manual page provides an index of such macros with pointers to
+other manual pages in the kernel section that provide all the relevant
+details.
+.Bl -tag -width Dv
+.
+.\" ---------
+.It Dv __HAVE_MUTEX_STUBS Pq Xr mutex 9
+The port provides fast path mutex enter and exit stubs.
+.
+.\" ---------
+.It Dv __HAVE_PREEMPTION Pq Xr cpu_need_resched 9
+The port can preempt kernel lwps with
+.Dv RESCHED_KPREEMPT .
+.
+.\" ---------
+.It Dv __HAVE_PTRACE_MACHDEP
+The port has MD
+.Xr ptrace 2
+requests, defines
+.Dv PTRACE_MACHDEP_REQUEST_CASES
+macro with
+.Ic case
+labels for its MD requests.
+.
+.\" ---------
+.It Dv __HAVE_RAS Pq Xr ras 9
+The port supports restartable atomic sequences.
+.
+.\" ---------
+.It Dv __HAVE_SIMPLE_MUTEXES Pq Xr mutex 9
+The port provides a CAS function that is either MP-safe, or does not
+need to be MP safe.
+Adaptive mutexes on these architectures do not require an additional
+interlock.
+.
+.\" ---------
+.It Dv __HAVE_SPIN_MUTEX_STUBS Pq Xr mutex 9
+The port provides fast path enter and exit stubs for spin mutexes.
+.El