From 1772ac3f492e9cefc36c05794c38b54c7069f22b Mon Sep 17 00:00:00 2001 From: Ruslan Ermilov Date: Mon, 5 Jul 2004 18:13:50 +0000 Subject: [PATCH] Slightly improve the markup. --- share/man/man9/pmap.9 | 10 +++++----- share/man/man9/pmap_addr_hint.9 | 2 +- share/man/man9/pmap_change_wiring.9 | 5 +++-- share/man/man9/pmap_clear_modify.9 | 4 ++-- share/man/man9/pmap_copy.9 | 6 ++++-- share/man/man9/pmap_enter.9 | 6 ++++-- share/man/man9/pmap_extract.9 | 12 +++++++++--- share/man/man9/pmap_is_modified.9 | 2 +- share/man/man9/pmap_is_prefaultable.9 | 2 +- share/man/man9/pmap_map.9 | 5 +++-- share/man/man9/pmap_mincore.9 | 6 +++--- share/man/man9/pmap_object_init_pt.9 | 6 ++++-- share/man/man9/pmap_page_protect.9 | 5 +++-- share/man/man9/pmap_zero_page.9 | 4 ++-- 14 files changed, 45 insertions(+), 30 deletions(-) diff --git a/share/man/man9/pmap.9 b/share/man/man9/pmap.9 index e022eb87ed96..b9dff676783c 100644 --- a/share/man/man9/pmap.9 +++ b/share/man/man9/pmap.9 @@ -50,9 +50,9 @@ is responsible for managing hardware-dependent objects such as page tables, address maps, TLBs, etc. .Pp Machine-dependent code must provide the header file -.Em . +.In machine/pmap.h . This file contains the definition of the -.Dv pmap +.Vt pmap structure: .Bd -literal -offset indent struct pmap { @@ -66,7 +66,7 @@ This header file may also define other data structures used by the implementation. .Pp The header file -.Em +.In vm/pmap.h defines a structure for tracking .Nm statistics (see below). @@ -79,11 +79,11 @@ struct pmap_statistics { .Ed .Pp The implementation's -.Vt struct pmap +.Vt "struct pmap" must contain an instance of this structure having the name .Va pm_stats , and it must be updated by the implementation after each relevant -.Nm pmap +.Nm operation. .Sh SEE ALSO .Xr pmap 9 , diff --git a/share/man/man9/pmap_addr_hint.9 b/share/man/man9/pmap_addr_hint.9 index 4449fbd5f200..42b82bf64de4 100644 --- a/share/man/man9/pmap_addr_hint.9 +++ b/share/man/man9/pmap_addr_hint.9 @@ -48,7 +48,7 @@ of bytes. .Sh IMPLEMENTATION NOTES This function is typically called on behalf of -.Fn mmap . +.Xr mmap 2 . .Sh RETURN VALUES If the implementation can use the address unchanged, it will simply return diff --git a/share/man/man9/pmap_change_wiring.9 b/share/man/man9/pmap_change_wiring.9 index 165ba572c388..bcf981d3841c 100644 --- a/share/man/man9/pmap_change_wiring.9 +++ b/share/man/man9/pmap_change_wiring.9 @@ -44,10 +44,11 @@ function changes the wiring attribute for the page at virtual address in the physical map .Fa pmap . A wired page gets its name from being -.Sq wired +.Dq wired into the system page tables so that it will not be paged out. .Pp -The mapping must already exist in the pmap. +The mapping must already exist in the +.Fa pmap . If .Fa wired is diff --git a/share/man/man9/pmap_clear_modify.9 b/share/man/man9/pmap_clear_modify.9 index a3572b2dd23e..3b994a360d53 100644 --- a/share/man/man9/pmap_clear_modify.9 +++ b/share/man/man9/pmap_clear_modify.9 @@ -43,14 +43,14 @@ The .Fn pmap_clear_modify function clears the -.Sq modified +.Dq modified bit on the physical page .Fa m . .Pp The .Fn pmap_clear_reference function clears the -.Sq referenced +.Dq referenced bit on the physical page .Fa m . .Sh SEE ALSO diff --git a/share/man/man9/pmap_copy.9 b/share/man/man9/pmap_copy.9 index c5738af3f867..d94c9ca97760 100644 --- a/share/man/man9/pmap_copy.9 +++ b/share/man/man9/pmap_copy.9 @@ -36,8 +36,10 @@ .In vm/vm.h .In vm/pmap.h .Ft void -.Fn pmap_copy "pmap_t dst_pmap" "pmap_t src_pmap" "vm_offset_t dst_addr" \ -"vm_size_t len" "vm_offset_t src_addr" +.Fo pmap_copy +.Fa "pmap_t dst_pmap" "pmap_t src_pmap" "vm_offset_t dst_addr" +.Fa "vm_size_t len" "vm_offset_t src_addr" +.Fc .Ft void .Fn pmap_copy_page "vm_page_t src" "vm_page_t dst" .Sh DESCRIPTION diff --git a/share/man/man9/pmap_enter.9 b/share/man/man9/pmap_enter.9 index c0e857d4ca19..c104310d6e71 100644 --- a/share/man/man9/pmap_enter.9 +++ b/share/man/man9/pmap_enter.9 @@ -35,8 +35,10 @@ .In vm/vm.h .In vm/pmap.h .Ft void -.Fn pmap_enter "pmap_t pmap" "vm_offset_t va" "vm_page_t p" "vm_prot_t prot" \ -"boolean_t wired" +.Fo pmap_enter +.Fa "pmap_t pmap" "vm_offset_t va" "vm_page_t p" "vm_prot_t prot" +.Fa "boolean_t wired" +.Fc .Sh DESCRIPTION The .Fn pmap_enter diff --git a/share/man/man9/pmap_extract.9 b/share/man/man9/pmap_extract.9 index 057ee013555b..f754277f9b8f 100644 --- a/share/man/man9/pmap_extract.9 +++ b/share/man/man9/pmap_extract.9 @@ -58,7 +58,7 @@ Currently, the page protection requested by the caller is not verified. In the .Fn pmap_extract_and_hold function, the -.Dv Giant +.Va Giant lock is held for the duration of the call to ensure that only a single caller is present. .Sh RETURN VALUES @@ -71,7 +71,11 @@ inside the physical map .Fa pmap . If the mapping does not exist, or if the .Fa pmap -parameter is NULL, then NULL will be returned. +parameter is +.Dv NULL , +then +.Dv NULL +will be returned. .Pp The .Fn pmap_extract_and_hold @@ -80,7 +84,9 @@ virtual address .Fa va inside the physical map .Fa pmap . -If the mapping does not exist, the result is a no-op, and NULL will +If the mapping does not exist, the result is a no-op, and +.Dv NULL +will be returned. .Sh SEE ALSO .Xr mutex 9 , diff --git a/share/man/man9/pmap_is_modified.9 b/share/man/man9/pmap_is_modified.9 index e58256fa8548..448b6df8c61c 100644 --- a/share/man/man9/pmap_is_modified.9 +++ b/share/man/man9/pmap_is_modified.9 @@ -49,7 +49,7 @@ functions return information about physical pages. The .Fn pmap_is_modified function returns the status of the -.Sq "page modified" +.Dq "page modified" bit for the physical page .Fa m . .Pp diff --git a/share/man/man9/pmap_is_prefaultable.9 b/share/man/man9/pmap_is_prefaultable.9 index 2fe2f0683e8a..1ea9507c1348 100644 --- a/share/man/man9/pmap_is_prefaultable.9 +++ b/share/man/man9/pmap_is_prefaultable.9 @@ -47,7 +47,7 @@ in the physical map may be pre-faulted into main memory. .Pp This is a helper function which is called by -.Fn vm_fault_prefault . +.Xr vm_fault_prefault 9 . .Sh SEE ALSO .Xr pmap 9 , .Xr vm_fault_prefault 9 diff --git a/share/man/man9/pmap_map.9 b/share/man/man9/pmap_map.9 index 8872323f9e8d..ea1e1496a6ae 100644 --- a/share/man/man9/pmap_map.9 +++ b/share/man/man9/pmap_map.9 @@ -35,8 +35,9 @@ .In vm/vm.h .In vm/pmap.h .Ft vm_offset_t -.Fn pmap_map "vm_offset_t *virt" "vm_paddr_t start" "vm_paddr_t end" \ -"int prot" +.Fo pmap_map +.Fa "vm_offset_t *virt" "vm_paddr_t start" "vm_paddr_t end" "int prot" +.Fc .Sh DESCRIPTION The .Fn pmap_map diff --git a/share/man/man9/pmap_mincore.9 b/share/man/man9/pmap_mincore.9 index d1ad399848cd..265d8f2287fe 100644 --- a/share/man/man9/pmap_mincore.9 +++ b/share/man/man9/pmap_mincore.9 @@ -44,7 +44,7 @@ function determines if the page at the virtual address in the physical map .Fa pmap is resident in physical memory. -It is the machine-dependent interface used by +It is the machine-dependent interface used by the .Xr mincore 2 system call. .Sh RETURN VALUES @@ -53,7 +53,7 @@ a mask of flags is returned, whose meaning is documented in .Xr mincore 2 ; otherwise, -.Ql 0 +0 is returned. .Pp The @@ -64,7 +64,7 @@ must be mapped into the .Fa pmap . If any error occurs, the machine-dependent implementation should return -.Ql 0 . +0. .Sh SEE ALSO .Xr mincore 2 , .Xr pmap 9 diff --git a/share/man/man9/pmap_object_init_pt.9 b/share/man/man9/pmap_object_init_pt.9 index 1745ab8f5dc9..efb242264e50 100644 --- a/share/man/man9/pmap_object_init_pt.9 +++ b/share/man/man9/pmap_object_init_pt.9 @@ -35,8 +35,10 @@ .In vm/vm.h .In vm/pmap.h .Ft void -.Fn pmap_object_init_pt "pmap_t pmap" "vm_offset_t addr" "vm_object_t object" \ -"vm_pindex_t pindex" "vm_size_t size" "int limit" +.Fo pmap_object_init_pt +.Fa "pmap_t pmap" "vm_offset_t addr" "vm_object_t object" +.Fa "vm_pindex_t pindex" "vm_size_t size" "int limit" +.Fc .Sh DESCRIPTION The .Fn pmap_object_init_pt diff --git a/share/man/man9/pmap_page_protect.9 b/share/man/man9/pmap_page_protect.9 index 6b04752b5aeb..abe360eec1f6 100644 --- a/share/man/man9/pmap_page_protect.9 +++ b/share/man/man9/pmap_page_protect.9 @@ -38,8 +38,9 @@ .Ft void .Fn pmap_page_protect "vm_page_t m" "vm_prot_t prot" .Ft void -.Fn pmap_protect "pmap_t pmap" "vm_offset_t sva" "vm_offset_t eva" \ -"vm_prot_t pr" +.Fo pmap_protect +.Fa "pmap_t pmap" "vm_offset_t sva" "vm_offset_t eva" "vm_prot_t pr" +.Fc .Sh DESCRIPTION The .Fn pmap_page_protect diff --git a/share/man/man9/pmap_zero_page.9 b/share/man/man9/pmap_zero_page.9 index 1b6daf6a85cb..fac1e256fe9f 100644 --- a/share/man/man9/pmap_zero_page.9 +++ b/share/man/man9/pmap_zero_page.9 @@ -55,10 +55,10 @@ entirely within a single page. The .Fn pmap_zero_page_idle interface is used by the -.Em vm_pagezero +.Nm vm_pagezero process. The system-wide -.Fa Giant +.Va Giant lock should not be required to be held in order to call this interface. .Sh IMPLEMENTATION NOTES This function is required to be implemented for each architecture supported by