Merge "LU-9771 flr: Merge branch 'flr'"

[fs/lustre-release.git] / lustre / doc / lustreapi.7

diff --git a/lustre/doc/lustreapi.7 b/lustre/doc/lustreapi.7
index c537853..261c024 100644 (file)
--- a/lustre/doc/lustreapi.7
+++ b/lustre/doc/lustreapi.7
@@ -1,8 +1,6 @@
-.
 .TH LUSTREAPI 7 "2014-09-21" "" "The Lustre API library"
 .SH NAME
 lustreapi \- The Lustre API library
-.
 .SH SYNOPSIS
 .sp
 \fB#include <lustre/lustreapi.h>\fP
@@ -10,54 +8,60 @@ lustreapi \- The Lustre API library
 .sp
 The lustreapi library provides functions to access and/or modify
 settings specific to the Lustre filesystem (allocation policies,
-quotas, etc).
-.sp
-The library provides the following functions:
-.sp
-.SH HSM FUNCTIONS
-.sp
-int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
-const char *mnt, int archive_count, int *archives,
-int rfd_flags)
-.sp
-int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
-.sp
-int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
-.sp
-int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
-struct hsm_action_list **hal, int *msgsize)
-.sp
-struct hsm_action_item *hai_first(struct hsm_action_list *hal)
-.sp
-struct hsm_action_item *hai_next(struct hsm_action_item *hai)
-.sp
-int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
-const struct hsm_copytool_private *ct, const struct
-hsm_action_item *hai, int restore_mdt_index, int
-restore_open_flags, bool is_error)
-.sp
-int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
-const struct hsm_extent *he, int hp_flags, int errval)
-.sp
-int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
-const struct hsm_extent *he, __u64 total, int hp_flags)
-.sp
-int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
-lustre_fid *fid)
-.sp
-int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
+quotas, file layouts, etc).  See the referenced man pages for details.
 .SH SEE ALSO
 .sp
-\fBlustre\fP(7),
-\fBllapi_file_create\fP(3),
-\fBllapi_file_open\fP(3),
-\fBllapi_file_get_stripe\fP(3),
-\fBllapi_layout\fP(3),
-\fBllapi_quotactl\fP(3),
-\fBllapi_hsm_action_begin\fP(3),
-\fBllapi_hsm_copytool_register\fP(3),
-\fBllapi_hsm_state_get\fP(3),
-\fBllapi_hsm_state_set\fP(3)
+.BR llapi_fd2parent (3),
+.BR llapi_file_create (3),
+.BR llapi_file_get_stripe (3),
+.BR llapi_file_open (3),
+.BR llapi_group_lock (3),
+.BR llapi_group_unlock (3),
+.BR llapi_hsm_action_begin (3),
+.BR llapi_hsm_action_end (3),
+.BR llapi_hsm_action_get_dfid (3),
+.BR llapi_hsm_action_get_fd (3),
+.BR llapi_hsm_action_progress (3),
+.BR llapi_hsm_copytool_get_fd (3),
+.BR llapi_hsm_copytool_recv (3),
+.BR llapi_hsm_copytool_register (3),
+.BR llapi_hsm_copytool_unregister (3),
+.BR llapi_hsm_state_get (3),
+.BR llapi_hsm_state_set (3),
+.BR llapi_ladvise (3),
+.BR llapi_layout_alloc (3),
+.BR llapi_layout_comp_add (3),
+.BR llapi_layout_comp_del (3),
+.BR llapi_layout_comp_extent_get (3),
+.BR llapi_layout_comp_extent_set (3),
+.BR llapi_layout_comp_flags_clear (3),
+.BR llapi_layout_comp_flags_get (3),
+.BR llapi_layout_comp_flags_set (3),
+.BR llapi_layout_comp_id_get (3),
+.BR llapi_layout_comp_use (3),
+.BR llapi_layout_comp_use_id (3),
+.BR llapi_layout_file_comp_add (3),
+.BR llapi_layout_file_comp_del (3),
+.BR llapi_layout_file_create (3),
+.BR llapi_layout_file_open (3),
+.BR llapi_layout_free (3),
+.BR llapi_layout_get_by_fd (3),
+.BR llapi_layout_get_by_fid (3),
+.BR llapi_layout_get_by_path (3),
+.BR llapi_layout_ost_index_get (3),
+.BR llapi_layout_ost_index_set (3),
+.BR llapi_layout_pattern_get (3),
+.BR llapi_layout_pattern_set (3),
+.BR llapi_layout_pool_name_get (3),
+.BR llapi_layout_pool_name_set (3),
+.BR llapi_layout_stripe_count_get (3),
+.BR llapi_layout_stripe_count_set (3),
+.BR llapi_layout_stripe_size_get (3),
+.BR llapi_layout_stripe_size_set (3),
+.BR llapi_path2fid (3),
+.BR llapi_path2parent (3),
+.BR llapi_quotactl (3),
+.BR lustre (7)
 .SH AUTHOR
 Lustre contributors
 .