Whamcloud - gitweb
LU-4315 docs: Fix Makefile.am to have one man page per line 71/24371/4
authorSteve Guminski <stephenx.guminski@intel.com>
Thu, 15 Dec 2016 15:20:05 +0000 (10:20 -0500)
committerOleg Drokin <oleg.drokin@intel.com>
Tue, 24 Jan 2017 05:23:12 +0000 (05:23 +0000)
The man pages for lfs(1) and lctl(8) are quite large. Splitting
them into one page per subcommand will allow for more detailed
information for each subcommand.

This patch modifies the Makefile.am so that the source man pages
are listed one per line.  This will make it easier for subsequent
patches to add new pages.  Existing pages that were missing from
the Makefile.am have been added to it, and an obsolete page has
been removed from the Makefile.am and been deleted.

Test-Parameters: trivial
Signed-off-by: Steve Guminski <stephenx.guminski@intel.com>
Change-Id: If312fff9bc5e68176caf0a70a51876e69b1614d8
Reviewed-on: https://review.whamcloud.com/24371
Tested-by: Jenkins
Tested-by: Maloo <hpdd-maloo@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Bob Glossman <bob.glossman@intel.com>
Reviewed-by: James Simmons <uja.ornl@yahoo.com>
lustre/doc/Makefile.am
lustre/doc/ll_decode_linkea.8
lustre/doc/ll_recover_lost_found_objs.8 [deleted file]

index eae6946..faebfd1 100644 (file)
 # Lustre is a trademark of Sun Microsystems, Inc.
 #
 
-MANFILES = lustre.7 lfs.1 mount.lustre.8 lctl.8 lnetctl.8 \
-       llverdev.8 llbackup.8 llapi_quotactl.3 llobdstat.8 llstat.8 \
-       plot-llstat.8 l_getidentity.8 lst.8 routerstat.8 llog_reader.8 \
-       llapi_file_open.3 llapi_file_create.3 llapi_file_get_stripe.3 \
-       lustre_rsync.8 lfs_migrate.1 lhbadm.8 ldev.8 ldev.conf.5 nids.5 \
-       lfs-hsm.1 llapi_hsm_state_get.3 llapi_hsm_state_set.3 \
-       lustre_routes_config.8 lustre_routes_conversion.8 \
-       lfs-setdirstripe.1 lfs-mkdir.1 lfs-getdirstripe.1 \
-       llapi_layout.7 llapi_layout_alloc.3 llapi_layout_file_create.3 \
-       llapi_layout_file_open.3 llapi_layout_free.3 llapi_layout_get_by_fd.3 \
-       llapi_layout_get_by_fid.3 llapi_layout_get_by_path.3 \
-       llapi_layout_ost_index_get.3 llapi_layout_ost_index_set.3 \
-       llapi_layout_pattern_get.3 llapi_layout_pattern_set.3 \
-       llapi_layout_pool_name_get.3 llapi_layout_pool_name_set.3 \
-       llapi_layout_stripe_count_get.3 llapi_layout_stripe_count_set.3 \
-       llapi_layout_stripe_size_get.3 llapi_layout_stripe_size_set.3 \
-       llapi_path2fid.3 llapi_group_lock.3 llapi_group_unlock.3 \
-       ll_decode_filter_fid.8 llapi_path2parent.3 llapi_fd2parent.3 \
-       llapi_hsm_copytool_unregister.3 llapi_hsm_copytool_get_fd.3 \
-       llapi_hsm_copytool_recv.3 llapi_hsm_action_end.3 \
-       llapi_hsm_action_progress.3 llapi_hsm_action_get_dfid.3 \
-       llapi_hsm_action_get_fd.3 lustreapi.7 llapi_hsm_action_begin.3 \
-       llapi_hsm_copytool_register.3 lfs-ladvise.1 llapi_ladvise.3 \
-       ll_decode_linkea.8 lgss_sk.8
+MANFILES =                                     \
+       lctl.8                                  \
+       lctl-network.8                          \
+       ldev.8                                  \
+       ldev.conf.5                             \
+       lfs.1                                   \
+       lfs-df.1                                \
+       lfs-getdirstripe.1                      \
+       lfs-hsm.1                               \
+       lfs-ladvise.1                           \
+       lfs_migrate.1                           \
+       lfs-migrate.1                           \
+       lfs-mkdir.1                             \
+       lfs-setdirstripe.1                      \
+       l_getidentity.8                         \
+       lgss_sk.8                               \
+       lhbadm.8                                \
+       llapi_fd2parent.3                       \
+       llapi_file_create.3                     \
+       llapi_file_get_stripe.3                 \
+       llapi_file_open.3                       \
+       llapi_group_lock.3                      \
+       llapi_group_unlock.3                    \
+       llapi_hsm_action_begin.3                \
+       llapi_hsm_action_end.3                  \
+       llapi_hsm_action_get_dfid.3             \
+       llapi_hsm_action_get_fd.3               \
+       llapi_hsm_action_progress.3             \
+       llapi_hsm_copytool_get_fd.3             \
+       llapi_hsm_copytool_recv.3               \
+       llapi_hsm_copytool_register.3           \
+       llapi_hsm_copytool_unregister.3         \
+       llapi_hsm_state_get.3                   \
+       llapi_hsm_state_set.3                   \
+       llapi_ladvise.3                         \
+       llapi_layout.7                          \
+       llapi_layout_alloc.3                    \
+       llapi_layout_file_create.3              \
+       llapi_layout_file_open.3                \
+       llapi_layout_free.3                     \
+       llapi_layout_get_by_fd.3                \
+       llapi_layout_get_by_fid.3               \
+       llapi_layout_get_by_path.3              \
+       llapi_layout_ost_index_get.3            \
+       llapi_layout_ost_index_set.3            \
+       llapi_layout_pattern_get.3              \
+       llapi_layout_pattern_set.3              \
+       llapi_layout_pool_name_get.3            \
+       llapi_layout_pool_name_set.3            \
+       llapi_layout_stripe_count_get.3         \
+       llapi_layout_stripe_count_set.3         \
+       llapi_layout_stripe_size_get.3          \
+       llapi_layout_stripe_size_set.3          \
+       llapi_path2fid.3                        \
+       llapi_path2parent.3                     \
+       llapi_quotactl.3                        \
+       llbackup.8                              \
+       ll_decode_filter_fid.8                  \
+       ll_decode_linkea.8                      \
+       llobdstat.8                             \
+       llog_reader.8                           \
+       llstat.8                                \
+       llverdev.8                              \
+       lnetctl.8                               \
+       lst.8                                   \
+       lustre.7                                \
+       lustreapi.7                             \
+       lustre_routes_config.8                  \
+       lustre_routes_conversion.8              \
+       lustre_rsync.8                          \
+       mount.lustre.8                          \
+       nids.5                                  \
+       plot-llstat.8                           \
+       routerstat.8
 
-SERVER_MANFILES = mkfs.lustre.8 tunefs.lustre.8 lshowmount.8
+SERVER_MANFILES =                              \
+       lctl-lfsck-query.8                      \
+       lctl-lfsck-start.8                      \
+       lctl-lfsck-stop.8                       \
+       lctl-nodemap-activate.8                 \
+       lctl-nodemap-add.8                      \
+       lctl-nodemap-add-idmap.8                \
+       lctl-nodemap-add-range.8                \
+       lctl-nodemap-del.8                      \
+       lctl-nodemap-del-idmap.8                \
+       lctl-nodemap-del-range.8                \
+       lctl-nodemap-modify.8                   \
+       lshowmount.8                            \
+       mkfs.lustre.8                           \
+       tunefs.lustre.8
 
 if SERVER
 MANFILES += $(SERVER_MANFILES)
index 9a43aff..98cf8f3 100644 (file)
@@ -49,5 +49,4 @@ could also be used on Lustre client.
 .PP
 .SH SEE ALSO
 .BR lfs (1),
-.BR lustre (7),
-.BR ll_recover_lost_found_objs (8)
+.BR lustre (7)
diff --git a/lustre/doc/ll_recover_lost_found_objs.8 b/lustre/doc/ll_recover_lost_found_objs.8
deleted file mode 100644 (file)
index cbd5d32..0000000
+++ /dev/null
@@ -1,38 +0,0 @@
-.TH ll_recover_lost_found_objs 1 "Aug 21, 2008" Lustre "utilities"
-.SH NAME
-ll_recover_lost_found_objs \- recover Lustre OST objects from lost+found
-.SH SYNOPSIS
-.B "ll_recover_lost_found_objs [-hnv] -d scan_directory"
-.br
-.SH DESCRIPTION
-.B ll_recover_lost_found_objs
-recovers objects from lost+found that might result from a
-Lustre OST with a corrupted directory. Running e2fsck will fix the
-directory, but puts all of the objects into lost+found, where they are
-inaccessible to Lustre.
-.TP
-.I "\-d scan_directory"
-Specify directory that will be scanned.  Normally this is the
-.RB ' lost+found '
-directory of an OST.
-.TP
-.I "\-h"
-Print help message.
-.TP
-.I "\-n"
-Run in non-fixing (dry-run) mode to report what would be fixed, but
-do not actually modify the filesystem.  If the
-.I scan_directory
-is specified as the OST object directory (i.e.
-.RB ' O ' )
-then the existing OST objects can be scanned to verify and repair
-their location in the object directory.
-.TP
-.I "\-v"
-Increase verbosity.
-.SH EXAMPLE
-.fi
-ll_recover_lost_found_objs -d /mnt/ost/lost+found
-.SH SEE ALSO
-.BR lustre (7),
-.BR ll_decode_filter_fid (8)