Whamcloud - gitweb
LU-6142 lustre: remove some unnecessary code.
[fs/lustre-release.git] / lustre / doc / llapi_layout_comp_add.3
index 7df9851..f91692f 100644 (file)
@@ -1,4 +1,4 @@
-.TH llapi_layout_comp_add 3 "2015 Nov 4" "Lustre User API"
+.TH llapi_layout_comp_add 3 "2017 Apr 7" "Lustre User API"
 .SH NAME
 llapi_layout_comp_add, llapi_layout_comp_del \- add or delete a layout
 component into/from the layout.
@@ -19,10 +19,12 @@ A composite layout is made of several layout components.
 .BR llapi_layout_comp_add (3)
 adds the layout component
 .I comp
-into the
-.IR layout .
-The
-.IR layout
+into the existing in-memory
+.I layout
+under construction, and
+.I comp
+is freed.  The
+.I layout
 will be turned into composite if it was plain before adding. All layout
 attributes of
 .I comp
@@ -34,15 +36,17 @@ functions.
 .BR llapi_layout_comp_del (3)
 deletes the layout component
 .I comp
-from the
-.IR layout .
+from the in-memory
+.IR layout ,
+but does not delete the component from an existing file layout on the MDT.
 .PP
 .SH RETURN VALUES
 .B llapi_layout_comp_add()
 and
 .B llapi_layout_comp_del()
-return 0 on success, or -1 if an error occurred (in which case, errno is
-set appropriately).
+return 0 on success, or -1 if an error occurred (in which case,
+.B errno
+is set appropriately).
 .SH ERRORS
 .TP 15
 .SM EINVAL
@@ -52,5 +56,6 @@ An invalid argument was specified.
 .BR llapi_layout_free (3),
 .BR llapi_layout_file_open (3),
 .BR llapi_layout_file_comp_add (3),
+.BR llapi_layout_file_comp_del (3),
 .BR llapi_layout (7),
 .BR lustreapi (7)