diff options
author | ngie <ngie@FreeBSD.org> | 2017-05-27 22:57:10 +0000 |
---|---|---|
committer | ngie <ngie@FreeBSD.org> | 2017-05-27 22:57:10 +0000 |
commit | f2e5e1c47a03c612eddc000ba25a7f840f9ffda1 (patch) | |
tree | e440801806e1ad7953ed987d6a9b1c91116bb6f3 /lib | |
parent | 01ba3589cc00414434fb804d358544237304996d (diff) | |
download | FreeBSD-src-f2e5e1c47a03c612eddc000ba25a7f840f9ffda1.zip FreeBSD-src-f2e5e1c47a03c612eddc000ba25a7f840f9ffda1.tar.gz |
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)).
Diffstat (limited to 'lib')
-rw-r--r-- | lib/libgeom/libgeom.3 | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/lib/libgeom/libgeom.3 b/lib/libgeom/libgeom.3 index bda0c9d..dbe21c8 100644 --- a/lib/libgeom/libgeom.3 +++ b/lib/libgeom/libgeom.3 @@ -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 |