Author: ngie
Date: Sat May 27 22:57:07 2017
New Revision: 319003
URL: https://svnweb.freebsd.org/changeset/base/319003
Log:
MFC r317288,r317289:
r317288:
libgeom(3): apply minor polish
- Use .Dv when mentioning NULL per mdoc(7).
- Reword `g_device_path`, `g_open_by_ident`, and `g_providername`'s
descriptions
so they're less wordy.
- Fix a typo in `g_device_path` (can not -> cannot).
Tested with: igor, make manlint
r317289:
libgeom(3): note that stdio.h is required when referencing gctl_dump(3)
gctl_dump(3) is only exposed when stdio.h is #include'd first, per its
addition in r112510. The reasoning noted for the conditional "exposure"
of the function was to "limit #include pollution".
This addresses an issue I found with the documentation when looking at
bug 218809, which in turn addresses a -Wimplicit-function-declaration
compiler warning in `tools/regression/geom_gpt/test.c` (it uses
gctl_dump(3)).
Modified:
stable/10/lib/libgeom/libgeom.3
Directory Properties:
stable/10/ (props changed)
Modified: stable/10/lib/libgeom/libgeom.3
==============================================================================
--- stable/10/lib/libgeom/libgeom.3 Sat May 27 22:40:20 2017
(r319002)
+++ stable/10/lib/libgeom/libgeom.3 Sat May 27 22:57:07 2017
(r319003)
@@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd December 4, 2010
+.Dd April 22, 2017
.Dt LIBGEOM 3
.Os
.Sh NAME
@@ -63,6 +63,10 @@
.Sh LIBRARY
.Lb libgeom
.Sh SYNOPSIS
+.Bd -literal
+/* stdio.h is only required for `gctl_dump` */
+.Ed
+.In stdio.h
.In libgeom.h
.Ss "Statistics Functions"
.Ft void
@@ -324,8 +328,8 @@ The
.Fn g_device_path
function returns the full path to a provider given a partial or full path to
the
device node.
-If the device can not be found or is not a valid geom provider, NULL is
-returned.
+.Dv NULL
+is returned if the device cannot be found or is not a valid geom provider.
.Pp
The
.Fn g_get_ident
@@ -344,20 +348,19 @@ string.
.Pp
The
.Fn g_open_by_ident
-function opens provider using its ident, unlike
+function opens provider using its identification, unlike
.Fn g_open
-which uses provider's name.
-If the
+which uses the provider's name.
+The function will store the provider's name in the
.Fa name
-argument is not
-.Dv NULL ,
-the function will store provider's name there.
+parameter if it is not
+.Dv NULL .
.Pp
The
.Fn g_providername
function returns the provider name of an open file descriptor.
-If the file descriptor does not point to a valid geom provider, NULL is
-returned.
+.Dv NULL
+is returned the file descriptor does not point to a valid geom provider.
.Pp
All functions except
.Fn g_providername
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/svn-src-stable-10
To unsubscribe, send any mail to "[email protected]"
