From 30c6a66864821d3b47e25612c0d2e727ec36154e Mon Sep 17 00:00:00 2001 From: Mitchell Horne Date: Wed, 12 Oct 2022 13:43:57 -0300 Subject: [PATCH] malloc(9): update names and hardlinks Give all documented functions a .Nm entry in the man page, following the order they are listed in the synopsis. Create MLINKs for each of the functions as well. While here, add a missing include directive to the synopsis, and appease mandoc by wrapping a long line. Reviewed by: markj, imp (previous version), jhb (previous version) MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D36940 --- share/man/man9/Makefile | 8 +++++++- share/man/man9/malloc.9 | 17 ++++++++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 9719cb17c177..4a5ecb2b0593 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1418,13 +1418,19 @@ MLINKS+=make_dev.9 destroy_dev.9 \ make_dev.9 make_dev_p.9 \ make_dev.9 make_dev_s.9 MLINKS+=malloc.9 free.9 \ + malloc.9 malloc_aligned.9 \ malloc.9 malloc_domainset.9 \ + malloc.9 malloc_domainset_aligned.9 \ + malloc.9 malloc_domainset_exec.9 \ + malloc.9 malloc_exec.9 \ + malloc.9 malloc_usable_size.9 \ malloc.9 mallocarray.9 \ malloc.9 mallocarray_domainset.9 \ malloc.9 MALLOC_DECLARE.9 \ malloc.9 MALLOC_DEFINE.9 \ malloc.9 realloc.9 \ - malloc.9 reallocf.9 + malloc.9 reallocf.9 \ + malloc.9 zfree.9 MLINKS+=mbchain.9 mb_detach.9 \ mbchain.9 mb_done.9 \ mbchain.9 mb_fixhdr.9 \ diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index c240344ea77e..26dcf3081f3e 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -29,16 +29,25 @@ .\" $NetBSD: malloc.9,v 1.3 1996/11/11 00:05:11 lukem Exp $ .\" $FreeBSD$ .\" -.Dd July 2, 2021 +.Dd October 12, 2022 .Dt MALLOC 9 .Os .Sh NAME .Nm malloc , +.Nm mallocarray , .Nm free , +.Nm zfree , .Nm realloc , .Nm reallocf , +.Nm malloc_usable_size , +.Nm malloc_aligned , +.Nm malloc_exec , +.Nm MALLOC_DECLARE , .Nm MALLOC_DEFINE , -.Nm MALLOC_DECLARE +.Nm malloc_domainset , +.Nm malloc_domainset_aligned , +.Nm malloc_domainset_exec , +.Nm mallocarray_domainset .Nd kernel memory management routines .Sh SYNOPSIS .In sys/types.h @@ -73,6 +82,7 @@ .Fn MALLOC_DEFINE type shortdesc longdesc .In sys/param.h .In sys/domainset.h +.In sys/malloc.h .Ft void * .Fn malloc_domainset "size_t size" "struct malloc_type *type" "struct domainset *ds" "int flags" .Ft void * @@ -116,7 +126,8 @@ Both and .Fn malloc_domainset_exec can be used to return executable memory. -Not all platforms enforce a distinction between executable and non-executable memory. +Not all platforms enforce a distinction between executable and non-executable +memory. .Pp The .Fn mallocarray