git: 7d69f46f6474 - stable/12 - MFC r368791: disk(9): Fix a few mandoc related errors

Gordon Bergling gbe at FreeBSD.org
Mon Dec 28 18:52:12 UTC 2020


The branch stable/12 has been updated by gbe (doc committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=7d69f46f6474d3d225fd7e1d6711c610db75eb55

commit 7d69f46f6474d3d225fd7e1d6711c610db75eb55
Author:     Gordon Bergling <gbe at FreeBSD.org>
AuthorDate: 2020-12-19 09:55:02 +0000
Commit:     Gordon Bergling <gbe at FreeBSD.org>
CommitDate: 2020-12-28 18:51:29 +0000

    MFC r368791: disk(9): Fix a few mandoc related errors
    
    - function name without markup: g_io_deliver()
    - function name without markup: disk_gone()
    - sections out of conventional order: Sh SEE ALSO
    - referenced manual not found: Xr MAKE_DEV 9
    
    Actually the man page of MAKE_DEV has never existed.
    
    (cherry picked from commit 9512f75fa8608d150178116ad63672672331b5e8)
---
 share/man/man9/disk.9 | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/share/man/man9/disk.9 b/share/man/man9/disk.9
index 081e63c67000..32c659c0a8e6 100644
--- a/share/man/man9/disk.9
+++ b/share/man/man9/disk.9
@@ -172,9 +172,11 @@ kernel panic to record a copy of the system RAM to the disk.
 Optional: if this method is provided, it gives the disk driver the
 opportunity to override the default GEOM response to BIO_GETATTR requests.
 This function should return -1 if the attribute is not handled, 0 if the
-attribute is handled, or an errno to be passed to g_io_deliver().
+attribute is handled, or an errno to be passed to
+.Fn g_io_deliver .
 .It Vt "disk_gone_t *" Va d_gone
-Optional: if this method is provided, it will be called after disk_gone()
+Optional: if this method is provided, it will be called after
+.Fn disk_gone
 is called, once GEOM has finished its cleanup process.
 Once this callback is called, it is safe for the disk driver to free all of
 its resources, as it will not be receiving further calls from GEOM.
@@ -241,15 +243,14 @@ Typically used to store a pointer to the drivers
 .Vt softc
 structure for this disk device.
 .El
+.Sh SEE ALSO
+.Xr GEOM 4 ,
+.Xr devfs 5
 .Sh HISTORY
 The
 .Nm kernel disk storage API
 first appeard in
 .Fx 4.9 .
-.Sh SEE ALSO
-.Xr GEOM 4 ,
-.Xr devfs 5 ,
-.Xr MAKE_DEV 9
 .Sh AUTHORS
 This manual page was written by
 .An Robert Watson .


More information about the dev-commits-src-all mailing list