LU-930 doc: add lnet man page

Add a simple lnet man page which provides a short description of
lnet and points to all lnet related commands, like lnetctl and lst.

This page will also help users find more lnet related pages using
apropos.

Test-Parameters: trivial
Signed-off-by: Timothy Day <timday@amazon.com>
Change-Id: Ia3c1be4e60118e00ab9378ef7cd2d53b25196cf2
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/51085
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Frank Sehr <fsehr@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>

diff --git a/lnet/doc/Makefile.am b/lnet/doc/Makefile.am
index a0eaa4f..02aaeb0 100644 (file)
--- a/lnet/doc/Makefile.am
+++ b/lnet/doc/Makefile.am
@@ -10,7 +10,8 @@
 
 MANFILES =                                     \
        lnetctl.8                               \
-       lst.8
+       lst.8                                   \
+       lnet.7
 
 if MANPAGES
 if UTILS

diff --git a/lnet/doc/lnet.7 b/lnet/doc/lnet.7
new file mode 100644 (file)
index 0000000..ab35855
--- /dev/null
+++ b/lnet/doc/lnet.7
@@ -0,0 +1,44 @@
+.TH LNET 7 "2023 Oct 8" LNet "Lustre networking layer"
+.SH NAME
+LNet
+.SH SYNOPSIS
+A lightweight and efficient network communication protocol that supports
+message passing for RPC request processing and RDMA for bulk data movement.
+.SH DESCRIPTION
+.B LNet
+is a high performance networking protocol. It is most commonly used by the
+Lustre filesystem.
+
+LNet supports many commonly-used network types, such as InfiniBand and IP
+networks, and allows simultaneous availability across multiple network types
+with routing between them. Remote direct memory access (RDMA) is permitted
+when supported by underlying networks using the appropriate Lustre network
+driver (LND). High availability and recovery features enable transparent
+recovery in conjunction with failover servers.
+
+.SH COMMANDS
+.TP
+.BR lnetctl (8)
+A low-level tool for administrators to control LNet configuration.
+.TP
+.BR lst (8)
+A low-level tool for administrators to confirm that LNet has been properly
+installed and configured. The self-test also confirms that LNet and the
+network software and hardware underlying it are performing according to
+expectations.
+.SH BUGS
+Please report all bugs to https://jira.whamcloud.com/
+.SH AVAILABILITY
+.B The
+.BR LNet (7)
+packages are available for download, alongside Lustre, at:
+.br
+https://downloads.whamcloud.com/
+and GPL source code is available at:
+.br
+https://git.whamcloud.com/
+.SH SEE ALSO
+.BR lnetctl (8),
+.BR lst (8),
+.BR lctl (8),
+.BR lustre (7)

diff --git a/lustre/doc/lustre.7 b/lustre/doc/lustre.7
index efecd71..e106ef9 100644 (file)
--- a/lustre/doc/lustre.7
+++ b/lustre/doc/lustre.7
@@ -81,4 +81,5 @@ https://git.whamcloud.com/
 .BR llog_reader (8),
 .BR lshowmount (8),
 .BR lustreapi (7),
-.BR lustre_rsync (8)
+.BR lustre_rsync (8),
+.BR lnet (7)