LU-11380 llapi: separate FID man pages

[fs/lustre-release.git] / lustre / doc / llapi_path2fid.3

diff --git a/lustre/doc/llapi_path2fid.3 b/lustre/doc/llapi_path2fid.3
index eb077b6..695aa31 100644 (file)
--- a/lustre/doc/llapi_path2fid.3
+++ b/lustre/doc/llapi_path2fid.3
@@ -1,11 +1,11 @@
-.TH llapi_path2fid 3 "2014 Mar 18" "Lustre User API"
+.TH llapi_path2fid 3 "2018-11-28" "Lustre User API"
 .SH NAME
-llapi_path2fid \- translate a path name to a Lustre FID
+llapi_path2fid \- translate a path name to a File Identifier
 .SH SYNOPSIS
 .nf
 .B #include <lustre/lustreapi.h>
 .PP
-.BI "int llapi_path2fid(const char *"path ", struct lu_fid *"fid );
+.BI "int llapi_path2fid(const char *" path ", struct lu_fid *" fid );
 .fi
 .SH DESCRIPTION
 .PP
@@ -17,15 +17,19 @@ into
 .IR fid .
 The
 .I fid
-may be then be passed to other llapi functions that expect the
+may be then be passed to other
+.B llapi_
+functions that expect the
 .B struct lu_fid
 data type.
 .SH RETURN VALUES
 .LP
-.B llapi_path2fid()
 returns 0 on success or a negative errno value on failure.
 .SH ERRORS
 .TP 15
+.SM -EINVAL
+An invalid argument was specified.
+.TP
 .SM -ENOTTY
 .I path
 does not reside on a Lustre filesystem.
@@ -33,10 +37,9 @@ does not reside on a Lustre filesystem.
 .SM -ENOENT
 .I path
 does not exist.
-.TP
-.SM -EINVAL
-An invalid argument was specified.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR llapi_layout_get_by_fid (3),
 .BR llapi_layout (7),
+.BR llapi_fid2path (3),
+.BR llapi_path2parent (3),
 .BR lustreapi (7)