LU-930 doc: improve formatting of lfs.1 synopsis

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

diff --git a/lustre/doc/llapi_file_get_stripe.3 b/lustre/doc/llapi_file_get_stripe.3
index 061976c..d3232fb 100644 (file)
--- a/lustre/doc/llapi_file_get_stripe.3
+++ b/lustre/doc/llapi_file_get_stripe.3
@@ -1,4 +1,4 @@
-.TH llapi_file_get_stripe 3 "2009 Jul 22" Lustre liblustreapi
+.TH lustreapi 3 "2009 Jul 22" The Lustre user application interface library
 .SH NAME
 llapi_file_get_stripe \- get striping information for a file or a directory on a Lustre filesystem
 .SH SYNOPSIS
@@ -6,10 +6,7 @@ llapi_file_get_stripe \- get striping information for a file or a directory on a
 .B #include <sys/types.h>
 .B #include <sys/stat.h>
 .B #include <fcntl.h>
-.B #include <liblustre.h>
-.B #include <lustre/lustre_idl.h>
-.B #include <lustre/liblustreapi.h>
-.B #include <lustre/lustre_user.h>
+.B #include <lustre/lustreapi.h>
 .sp
 .BI "int llapi_file_get_stripe(const char *"path ", void *"lum );
 .sp
@@ -28,7 +25,7 @@ struct lov_user_md_v1 {
         __u32 lmm_magic;
         __u32 lmm_pattern;
         __u64 lmm_object_id;
-        __u64 lmm_object_gr;
+        __u64 lmm_object_seq;
         __u32 lmm_stripe_size;
         __u16 lmm_stripe_count;
         __u16 lmm_stripe_offset;
@@ -39,11 +36,11 @@ struct lov_user_md_v3 {
         __u32 lmm_magic;
         __u32 lmm_pattern;
         __u64 lmm_object_id;
-        __u64 lmm_object_gr;
+        __u64 lmm_object_seq;
         __u32 lmm_stripe_size;
         __u16 lmm_stripe_count;
         __u16 lmm_stripe_offset;
-        char  lmm_pool_name[LOV_MAXPOOLNAME];
+        char  lmm_pool_name[LOV_MAXPOOLNAME + 1];
         struct lov_user_ost_data_v1 lmm_objects[0];
 } __attribute__((packed));
 .fi
@@ -87,7 +84,7 @@ members containing per OST file information in the following format:
 .nf
 struct lov_user_ost_data_v1 {
         __u64 l_object_id;
-        __u64 l_object_gr;
+        __u64 l_object_seq;
         __u32 l_ost_gen;
         __u32 l_ost_idx;
 } __attribute__((packed));
@@ -96,7 +93,7 @@ struct lov_user_ost_data_v1 {
 .I l_object_id
 holds the OST object id.
 .TP 20
-.I l_object_gr
+.I l_object_seq
 holds the OST object group.
 .TP 20
 .I l_ost_gen
@@ -140,12 +137,7 @@ is not properly mapped.
 .SH "EXAMPLE"
 .nf
 #include <sys/vfs.h>
-#include <liblustre.h>
-#include <lnet/lnetctl.h>
-#include <obd.h>
-#include <lustre_lib.h>
-#include <lustre/liblustreapi.h>
-#include <obd_lov.h>
+#include <lustre/lustreapi.h>
 
 static inline int maxint(int a, int b)
 {
@@ -201,4 +193,4 @@ cleanup:
 .fi
 .SH "SEE ALSO"
 .BR lustre (7),
-.BR liblustreapi (7)
+.BR lustreapi (7)