LU-18148 doc: add lctl-llog_remove man page

Add lctl-llog_remove man page.

Test-Parameters: trivial
Signed-off-by: Frederick Dilger <fdilger@whamcloud.com>
Change-Id: Ia0ec89b94a16047987977b4fe1e6b7ddc8d1a14d
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/56226
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>

diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am
index 889c0d3..bbe0ce0 100644 (file)
--- a/lustre/doc/Makefile.am
+++ b/lustre/doc/Makefile.am
@@ -231,6 +231,7 @@ SERVER_MANFILES =                           \
        lctl-llog_catlist.8                     \
        lctl-llog_info.8                        \
        lctl-llog_print.8                       \
+       lctl-llog_remove.8                      \
        lctl-del_ost.8                          \
        lctl-nodemap-activate.8                 \
        lctl-nodemap-add-idmap.8                \

diff --git a/lustre/doc/lctl-llog_remove.8 b/lustre/doc/lctl-llog_remove.8
new file mode 100644 (file)
index 0000000..03b9c2f
--- /dev/null
+++ b/lustre/doc/lctl-llog_remove.8
@@ -0,0 +1,51 @@
+.TH LCTL-LLOG_REMOVE 8 2024-12-09 Lustre "Lustre Configuration Utilities"
+.SH NAME
+lctl-llog_remove \- remove one log from catalog or plain log, erase it from disk
+.SH SYNOPSIS
+.SY "lctl llog_remove"
+.BI --log_id " ID"
+.RI { LOGNAME | FID }
+.YS
+.SH DESCRIPTION
+.B lctl llog_remove
+is used to remove log given by
+.I ID
+from the
+.I LOGNAME
+configuration log or the log's
+.IR FID ,
+typically on the MGS.
+See
+.BR lctl-llog_catlist (8)
+for a list of configuration logs.
+.SH OPTIONS
+.TP
+.BI --log_id ID
+The record
+.I ID
+number to remove, as printed by
+.B lctl llog_info
+for that log.
+.SH EXAMPLES
+To remove logid "0xa:0x3:0x0" from the
+.B testfs_client
+conf_param log:
+.RS
+.EX
+.B # lctl llog_remove testfs_client --log_id "0xa:0x3:0x0"
+.EE
+.RE
+.SH AVAILABILITY
+.B lctl llog_remove
+is a subcommand of
+.BR lctl (8)
+and is distributed as part of the
+.BR lustre (7)
+filesystem package since release 0.6.0
+.\" Added in commit 0.0.0-2194-g040033cef2
+.SH SEE ALSO
+.BR lctl (8),
+.BR lctl-llog_cancel (8),
+.BR lctl-llog_catlist (8),
+.BR lctl-llog_info (8),
+.BR lctl-llog_print (8)