X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Fllapi_path2fid.3;h=695aa31eb8c8e940e5921a3b9c8b137242a31351;hb=4e86479d2ae7f5a966d0fe96735f91e0b8ec3032;hp=eb077b642ac0125a4cbb17b75a1eb236b1b62ef5;hpb=06be2b427fbca4f8a9a2be37b951a47ef3315925;p=fs%2Flustre-release.git diff --git a/lustre/doc/llapi_path2fid.3 b/lustre/doc/llapi_path2fid.3 index eb077b6..695aa31 100644 --- 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 .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)