Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 22 Apr 2017 19:11:38 +0000 (UTC)
From:      Ngie Cooper <ngie@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r317288 - head/lib/libgeom
Message-ID:  <201704221911.v3MJBcZx042736@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: ngie
Date: Sat Apr 22 19:11:37 2017
New Revision: 317288
URL: https://svnweb.freebsd.org/changeset/base/317288

Log:
  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).
  
  MFC after:	5 weeks
  Tested with:	igor, make manlint
  Sponsored by:	Dell EMC Isilon

Modified:
  head/lib/libgeom/libgeom.3

Modified: head/lib/libgeom/libgeom.3
==============================================================================
--- head/lib/libgeom/libgeom.3	Sat Apr 22 18:59:50 2017	(r317287)
+++ head/lib/libgeom/libgeom.3	Sat Apr 22 19:11:37 2017	(r317288)
@@ -28,7 +28,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 4, 2010
+.Dd April 22, 2017
 .Dt LIBGEOM 3
 .Os
 .Sh NAME
@@ -324,8 +324,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 +344,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



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201704221911.v3MJBcZx042736>