Whamcloud - gitweb
LU-11099 doc: include "-N" option to lfs_setstripe.1
[fs/lustre-release.git] / lustre / doc / llapi_layout_file_comp_del.3
index eb854e1..3e91d07 100644 (file)
@@ -7,25 +7,30 @@ from an existing file.
 .B #include <lustre/lustreapi.h>
 .PP
 .BI "int llapi_layout_file_comp_del(const char *" path ",
 .B #include <lustre/lustreapi.h>
 .PP
 .BI "int llapi_layout_file_comp_del(const char *" path ",
-.BI "                               uint32_t "id );
+.BI "                               uint32_t "id ", uint32_t "flags );
 .fi
 .SH DESCRIPTION
 .PP
 Deletes the layout component(s) specified by
 .I id
 .fi
 .SH DESCRIPTION
 .PP
 Deletes the layout component(s) specified by
 .I id
+or
+.I flags
 from an existing file. The
 .I id
 from an existing file. The
 .I id
-can be a real unique component ID or a
-.IR lcme_id .
+must be a real unique component ID, when
+.I flags
+is specified,
+.I id
+must be set to zero.
 Available
 Available
-.IR lcme_id
+.IR flags
 are:
 .PP
 are:
 .PP
-.BR LCME_ID_ALL:
-All components in the layout.
+.BR LCME_FL_INIT:
+Instantiated components in the layout.
 .PP
 .PP
-.BR LCME_ID_NONE|LCME_FL_INIT:
-All the instantiated components in the layout.
+.BR LCME_FL_NEG|LCME_FL_INIT:
+Uninstantiated components in the layout.
 .SH RETURN VALUES
 Returns 0 on success, or -1 if an error occurred (in which case, errno is
 set appropriately).
 .SH RETURN VALUES
 Returns 0 on success, or -1 if an error occurred (in which case, errno is
 set appropriately).
@@ -37,15 +42,12 @@ An invalid argument was specified.
 .SM ENOENT
 .I path
 doesn't exist or the specified component isn't found in file.
 .SM ENOENT
 .I path
 doesn't exist or the specified component isn't found in file.
-.SH TODO
-Add description for the
-.IR lcme_id .
 .SH "SEE ALSO"
 .BR llapi_layout_alloc (3),
 .BR llapi_layout_file_open (3),
 .BR llapi_layout_get_by_path (3),
 .BR llapi_layout_file_comp_add (3),
 .BR llapi_layout_comp_id_get (3),
 .SH "SEE ALSO"
 .BR llapi_layout_alloc (3),
 .BR llapi_layout_file_open (3),
 .BR llapi_layout_get_by_path (3),
 .BR llapi_layout_file_comp_add (3),
 .BR llapi_layout_comp_id_get (3),
-.BR llapi_layout_comp_move_at (3),
+.BR llapi_layout_comp_use_id (3),
 .BR llapi_layout (7),
 .BR llapi_layout (7),
-.BR liblustreapi (7)
+.BR lustreapi (7)