Whamcloud - gitweb
LU-18110 doc: Fix typos in lustre/doc 50/55950/5
authorOleg Drokin <green@whamcloud.com>
Wed, 7 Aug 2024 05:03:51 +0000 (01:03 -0400)
committerOleg Drokin <green@whamcloud.com>
Thu, 8 Aug 2024 00:20:08 +0000 (00:20 +0000)
Fixed typos galore, pretty obvious ones went into this commit,
more advanced types will follow separately

Change-Id: Ief6624c6bd297548a04ef65a1312f32b752d7f7a
Test-Parameters: trivial
Signed-off-by: Oleg Drokin <green@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/55950
Reviewed-by: Frederick Dilger <fdilger@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
36 files changed:
lustre/doc/lctl-barrier.8
lustre/doc/lctl-get_param.8
lustre/doc/lctl-lfsck-start.8
lustre/doc/lctl-lfsck-stop.8
lustre/doc/lctl-list_param.8
lustre/doc/lctl-pcc.8
lustre/doc/lctl-snapshot-create.8
lustre/doc/lctl-snapshot-umount.8
lustre/doc/lctl.8
lustre/doc/ldev.conf.5
lustre/doc/lfs-heat_get.1
lustre/doc/lfs-heat_set.1
lustre/doc/lfs-ladvise.1
lustre/doc/lfs-migrate.1
lustre/doc/lfs-mirror-copy.1
lustre/doc/lfs-mirror-create.1
lustre/doc/lfs-mirror-extend.1
lustre/doc/lfs-mirror-write.1
lustre/doc/lgss_sk.8
lustre/doc/lhbadm.8
lustre/doc/ll_decode_filter_fid.8
lustre/doc/llapi_fid_to_handle.3
lustre/doc/llapi_get_lum_file_fd.3
lustre/doc/llapi_layout.7
lustre/doc/llapi_layout_alloc.3
lustre/doc/llapi_layout_get_by_fd.3
lustre/doc/llapi_layout_ost_index_get.3
lustre/doc/llapi_pcc_attach.3
lustre/doc/llapi_rmfid.3
lustre/doc/llapi_root_path_open.3
lustre/doc/lshowmount.8
lustre/doc/lustre_routes_config.8
lustre/doc/lustre_routes_conversion.8
lustre/doc/lustre_rsync.8
lustre/doc/mkfs.lustre.8
lustre/doc/mount.lustre.8

index a360dab..f49587a 100644 (file)
@@ -70,7 +70,7 @@ will be printed.
 Scan the system to check which MDTs are active. The status of the MDTs is
 required because the
 .B barrier_freeze
-will be unsuccessful if any of the MDTs are permenantly offline. During
+will be unsuccessful if any of the MDTs are permanently offline. During
 the rescan, the MDT status is updated. If an MDT does not respond the
 .B barrier_rescan
 within the given
index 2455406..e7910f0 100644 (file)
@@ -68,7 +68,7 @@ useful when using patterns. This option is equivalent to
 Recursively show all of the parameter names below the specified name.
 .TP
 .B -y ", " --yaml
-Some paramters can be presented in a YAML format but are not by default. This
+Some parameters can be presented in a YAML format but are not by default. This
 will format the parameter data in YAML. If the YAML provides a source: field
 it can be suppressed with the -n option.
 
index 1a40a15..c6a84f8 100644 (file)
@@ -27,7 +27,7 @@ multiple devices on current server.
 .TP
 .B  -A, --all
 Start LFSCK on all available devices in the system by single LFSCK command.
-Such LFSCK command can be executed on any MDT deivce in the system.
+Such LFSCK command can be executed on any MDT device in the system.
 .TP
 .B  -c, --create-ostobj [on | off]
 Create the lost OST-object for dangling LOV EA: 'off' (default) or 'on'. Under
@@ -45,10 +45,10 @@ re-create the missed MDT-object.
 Delay to create the lost OST-object for dangling LOV EA until orphan OST-objects
 handled: 'off' (default) or 'on'. If both "--create-ostobj" and the delay option
 are 'on', then the LFSCK will NOT create the OST-object to repair dangling LOV
-EA unless all the OST-objects have been handled. It can avoid reparing dangling
+EA unless all the OST-objects have been handled. It can avoid repairing dangling
 LOV EA incorrectly because of LOV EA corruption. The side-effect is that as long
 as one OST does not join the layout LFSCK or fail to complete the scanning, then
-reparing dangling LOV EA will be skipped. For a large system with a lot of OSTs,
+repairing dangling LOV EA will be skipped. For a large system with a lot of OSTs,
 such condition may be a bit strict. The default value is 'off'.
 .TP
 .B  -e, --error <error_handle>
index 6006f62..3f52371 100644 (file)
@@ -19,7 +19,7 @@ multiple devices on current server.
 .TP
 .B  -A, --all
 Stop LFSCK on all available devices in the system by single LFSCK command.
-Such LFSCK command can be executed on any MDT deivce in the system.
+Such LFSCK command can be executed on any MDT device in the system.
 .TP
 .B  -h, --help
 Show this help.
index f43eadc..7fdf442 100644 (file)
@@ -111,5 +111,5 @@ Compare this to the same command with --links enabled
 .SH SEE ALSO
 .BR lustre (7),
 .BR lctl-get_param (8),
-.BR lctl-set_parm (8),
+.BR lctl-set_param (8),
 .BR lfs (1)
index fd097a6..3e409be 100644 (file)
@@ -33,7 +33,7 @@ The following rule expressions are supported:
 - "projid={100}&size>{1M}&size<{500G}"
 - "projid>{100}&projid<{110}"
 - "uid<{1500}&uid>{1000}"
-Currently each PCC backend only has one rule which is configed when setup PCC
+Currently each PCC backend only has one rule which is configured when setup PCC
 backend on a client. If a user wants to change the rule, the PCC backend needs
 to be removed first and then added back with a new rule.
 .TP
index 0615453..7f4053d 100644 (file)
@@ -61,7 +61,7 @@ If write barrier is
 .BR on ,
 then the
 .I timeout
-specifies the write barrier's lifetime in second. The default vaule is 30.
+specifies the write barrier's lifetime in second. The default value is 30.
 
 .SH AVAILABILITY
 .B lctl-snapshot-create
index 28ac1f8..1e067e6 100644 (file)
@@ -7,7 +7,7 @@ lctl-snapshot_umount \- unmount Lustre snapshot
               {-n | --name ssname} [-r | --rsh remote_shell]
 .br
 .SH DESCRIPTION
-Umount the specified snapshot on the servers.
+Unmount the specified snapshot on the servers.
 .SH OPTIONS
 .TP
 .BR  -F ", " --fsname " "\fIfsname
@@ -17,7 +17,7 @@ The filesystem name.
 For help information.
 .TP
 .BR  -n ", " --name " "\fIssname
-The snapshot (to be umounted) name must be specified.
+The snapshot (to be unmounted) name must be specified.
 .TP
 .BR  -r ", " --rsh " "\fIremote_shell
 Specify a shell to communicate with remote targets. The default value is
index 86a6c6c..8325d47 100644 (file)
@@ -68,7 +68,7 @@ in another cases). To start the MGS service only:
 mount -t lustre <MDT partition> -o nosvc <mount point>
 Note the replace_nids command skips any invalidated records in the configuration log.
 The previous log is backed up with the suffix '.bak'.
-Failover nids must be passed after ':' symbol. More then
+Failover nids must be passed after ':' symbol. More than
 one failover can be set (every failover nids after ':' symbol).
 .TP
 .BI ping " <nid> timeout"
@@ -269,7 +269,7 @@ replacing the old lfsck tool for kinds of Lustre inconsistency verification,
 including: corrupted or lost OI mapping, corrupted or lost link EA, corrupted
 or lost FID in name entry, dangling name entry, multiple referenced name entry,
 unmatched MDT-object and name entry pairs, orphan MDT-object, incorrect
-MDT-object links count, corrupted namespace, corrupted or lost lov EA, lost
+MDT-object links count, corrupted namespace, corrupted or lost LOV EA, lost
 OST-object, multiple referenced OST-object, unmatched MDT-object and OST-object
 pairs, orphan OST-object, and so on.
 
index f108785..329d0c5 100644 (file)
@@ -13,7 +13,7 @@ The name of the host where the device normally runs.
 .TP
 .I "foreign hostname"
 The name of the host where the device runs when failed over.
-If failover is not used, insert a hypen as a placeholder.
+If failover is not used, insert a hyphen as a placeholder.
 .TP
 .I "label"
 The Lustre label associated with the device in the form \fIfsname-SRVnnnn\fR
index 761d069..ff7faf2 100644 (file)
@@ -30,7 +30,7 @@ Turn on file heat on given files.
 Turn on file heat support for the Lustre filesystem:
 .B $ lctl set_param llite.$FSNAME*.file_heat=1
 .TP
-Trun off file heat support for the Lustre filesystem:
+Turn off file heat support for the Lustre filesystem:
 .B $ lctl set_param llite.$FSNAME*.file_heat=0
 .TP
 Display current file heat for foo:
index 405b8e0..978a604 100644 (file)
@@ -1 +1 @@
-.so man1/lfs-heat.1
+.so man1/lfs-heat_get.1
index 26d3339..933fe13 100644 (file)
@@ -11,7 +11,7 @@ lfs-ladvise \- give file access advices or hints to server.
 .br
 .SH DESCRIPTION
 Give file access advices or hints to Lustre server side, usually OSS. This lfs
-command is simlar to the Linux
+command is similar to the Linux
 .BR fadvise64 (2)
 system call and
 .BR posix_fadvise (2),
@@ -56,7 +56,7 @@ Typically,
 .B lfs ladvise
 forwards the advice to Lustre servers without
 guaranteeing how and when servers will react to the advice. Actions may or
-may not be triggered when the advices are recieved, depending on the type of
+may not be triggered when the advices are received, depending on the type of
 the advice, whether the backing filesystem type supports that advice, as well
 as the real-time decision of the affected server-side components.
 
index ae41e01..1a7ce54 100644 (file)
@@ -119,7 +119,7 @@ and future metadata workload. If
 is -1, the MDT index will be balanced by free space and inodes among
 available MDTs.  If multiple
 .I MDT_INDEX
-values are specified in a comma-seperated list, then all
+values are specified in a comma-separated list, then all
 subdirectories will be
 .B striped
 across all of the specified MDT indices as if an equivalent
index 5439237..1903be5 100644 (file)
@@ -11,7 +11,7 @@ This command copies a mirror's content to other mirror(s) of a mirrored file,
 the file is specified by the path name \fImirrored_file\fR, the mirrors are
 specified by their mirror ID.
 .SH NOTE
-Be ware that the written mirror(s) will be marked as non-stale mirror(s),
+Beware that the written mirror(s) will be marked as non-stale mirror(s),
 be careful that after using this command, you could get a file with non-stale
 mirrors while containing different contents.
 .br
index 3ccb839..75bde7a 100644 (file)
@@ -46,7 +46,7 @@ Where available \fIflags\fR are as follows:
 .TP
 .BI prefer
 is supported in mirror creation. This flag will be set to all components that
-belong to ths corresponding mirror. The \fBprefer\fR flag gives hint to Lustre
+belong to the corresponding mirror. The \fBprefer\fR flag gives hint to Lustre
 for which mirrors should be used to serve I/O. When a mirrored file is being
 read, the component(s) with \fBprefer\fR are likely to be picked to serve the
 read; and when a mirrored file is prepared to be written, the MDT will
index 4076be9..fe1943c 100644 (file)
@@ -40,7 +40,7 @@ removed.  The \fISETSTRIPE_OPTIONS\fR cannot be specified with
 If \fIVICTIM_FILE\fR is specified, the utility will verify that the file contents
 from \fIVICTIM_FILE\fR are the same as \fIFILENAME\fR. Otherwise the command
 will return failure. However, option \fB\-\-no\-verify\fR can be used to
-override this verification. The option can save siginificant time on file
+override this verification. The option can save significant time on file
 comparison if the file size is large, but use it only when the file contents
 are known to be the same.
 .br
index 979b99c..ee3093f 100644 (file)
@@ -25,7 +25,7 @@ another mirror of the same mirrored file, use \fBlfs mirror copy\fR command.
 .SH EXAMPLES
 .TP
 .B lfs mirror write --mirror-id 3 /mnt/lustre/file1 < /tmp/m2
-Write the content of /mnt/m2 to the mirror with miro ID 3 for
+Write the content of /mnt/m2 to the mirror with mirror ID 3 for
 /mnt/lustre/file1.
 .TP
 .B lfs mirror write -N2 -i /tmp/m2 /mnt/lustre/file1
index 23803ed..052787f 100644 (file)
@@ -47,7 +47,7 @@ Seconds before session contexts generated from key expire and are regenerated
 File system name for key.
 .TP
 .I "-g, --mgsnids <nids>"
-Comma seperated list of MGS NIDs.  Only required when mgssec is used (Default: "").
+Comma-separated list of MGS NIDs.  Only required when mgssec is used (Default: "").
 .TP
 .I "-n, --nodemap <name>"
 Nodemap name for key (Default: "default").
index c37dc89..3a39da8 100644 (file)
@@ -8,7 +8,7 @@ lhbadm \- Lustre failover utility
 .br
 .SH DESCRIPTION
 .B lhbadm
-simlifies heartbeat administration on Lustre clusters.
+simplifies heartbeat administration on Lustre clusters.
 It offers the following operations:
 .TP
 .B status
index b3ff422..488e709 100644 (file)
@@ -36,7 +36,7 @@ This shows that the 3 files in lost+found have decimal object IDs 690670,
 614725, and 533088, respectively.  The object sequence number (formerly
 object group) is 0 for all current OST objects.
 .PP
-The MDT parent inode FIDs are hexdecimal numbers of the form
+The MDT parent inode FIDs are hexadecimal numbers of the form
 sequence:oid:idx.  Since the sequence number is below 0x100000000 in
 all these cases, the FIDs are in the IGIF (legacy Inode and Generation
 In FID) namespace and are mapped directly to the MDT inode = seq and
index 97b4372..38136f3 100644 (file)
@@ -20,7 +20,7 @@ This is similar to the
 .BR name_to_handle_at (2)
 function, and is useful for Lustre-specific tools and interfaces.  While the
 .BR llapi_fid_to_handle (3)
-function does not requre root access itself, the
+function does not require root access itself, the
 .BR open_by_handle_at (2)
 function
 .B does
index 46699d4..124c388 100644 (file)
@@ -1,7 +1,7 @@
 .TH llapi_get_lum_file_fd 3 "2019 July 15" "Lustre User API"
 .SH NAME
 llapi_get_lum_file_fd, llapi_get_lum_dir_fd, llapi_get_lum_file,
-llapi_get_lum_dir \- get valid file attrbutes and LOV stripe information to
+llapi_get_lum_dir \- get valid file attributes and LOV stripe information to
 the user.
 
 .SH SYNOPSIS
@@ -115,7 +115,7 @@ OBD_MD_FLTYPE
 The returned object type (mode & S_IFMT) is valid.
 .TP
 OBD_MD_FLUID
-The returned user ID is vaild.
+The returned user ID is valid.
 .TP
 OBD_MD_FLGID
 The returned group ID is valid.
index b7c61a7..574bdd8 100644 (file)
@@ -143,7 +143,7 @@ Example 2: Create file with composite layout.
        comp = llapi_layout_alloc();
        llapi_layout_comp_add(head, comp);
        llapi_layout_comp_extent_set(head, comp, 67108864,
-                            (u_int64t)-1); //[64M, EOF)
+                            (uint64_t)-1); //[64M, EOF)
        llapi_layout_stripe_count_set(comp, LLAPI_LAYOUT_WIDE);
 
        /* Create file with specified composite layout */
index 3bab4cc..c7a1ca1 100644 (file)
@@ -50,7 +50,7 @@ returns a valid pointer on success or
 .B NULL
 on failure with
 .B errno
-set to an approporiate error code.
+set to an appropriate error code.
 .sp
 .B llapi_layout_free()
 returns no value.
index f158eaa..377835e 100644 (file)
@@ -161,7 +161,7 @@ These functions return a valid pointer on success or
 .B NULL
 on failure with
 .B errno
-set to an approporiate error code.
+set to an appropriate error code.
 .SH ERRORS
 .TP 15
 .SM ENOMEM
index 6022e7c..5e3b990 100644 (file)
@@ -41,7 +41,7 @@ It is an error to call
 .B llapi_layout_ost_index_get()
 with a
 .I layout
-that was not initialized with with one of
+that was not initialized with one of
 .BR llapi_layout_get_by_fd() ,
 .BR llapi_layout_get_by_fid() ,
 or
index a283559..074ef66 100644 (file)
@@ -46,7 +46,7 @@ data structure, which contains the following values:
 .fi
 .TP
 LU_PCC_NONE
-menas that the file is not cached on PCC.
+means that the file is not cached on PCC.
 .TP
 LU_PCC_READWRITE
 means RW-PCC mode.
index a6cb6cc..ea399bc 100644 (file)
@@ -28,7 +28,7 @@ Is similar to
 .I llapi_rmfid.
 It tries to remove Lustre files by FIDs stored in
 .I fa->fa_fids
-where path or device is pointed by an already verifed
+where path or device is pointed by an already verified
 .I fd.
 
 .SH RETURN VALUES
index 428c60c..0bd26a4 100644 (file)
@@ -15,7 +15,7 @@ llapi_root_path_open \- Return open fd for a given device/path provided
 .B llapi_root_path_open(\|)
 is called with
 .I device
-which points to the FSNAME or complete path specifying a mountpount of Lustre
+which points to the FSNAME or complete path specifying a mountpoint of Lustre
 filesystem. On success,
 .I fd
 is populated with valid descriptor.
index a2ad08e..7e04826 100644 (file)
@@ -7,7 +7,7 @@ lshowmount \- show lustre exports
 .SH DESCRIPTION
 .B lshowmount
 Utility to show the hosts that have lustre currently mounted to a server.
-Ths utility looks for any exports from the mgs, mds, and obdfilter.
+This utility looks for any exports from the mgs, mds, and obdfilter.
 .SH OPTIONS
 .B lshowmount
 accepts the following options:
index 125ac1e..703421f 100644 (file)
@@ -11,7 +11,7 @@ configure routes on LNET startup.
 The format of the config file is:
 .br
 <network>: { gateway: <gateway>@<exit network> [hop: <hop>]
-             [priority: <prioirty>] }
+             [priority: <priority>] }
 .LP
 Usage:
 .br
index 7a02e4e..654ec77 100644 (file)
@@ -5,7 +5,7 @@ the new syntax.
 .SH SYNOPSIS
 .B "lustre_routes_conversion"
 .SH DESCRIPTION
-lustre_route_conversion takes as a first parameter a file with routes
+lustre_routes_conversion takes as a first parameter a file with routes
 configured as follows:
 .LP
 <network> [<hop>] <gateway>@<exit network>[:<priority>];
@@ -13,7 +13,7 @@ configured as follows:
 Then converts it to:
 .LP
 <network>: { gateway: <gateway>@<exit network> [hop: <hop>]
-             [priority: <prioirty>] }
+             [priority: <priority>] }
 .LP
 and appends it to the output file passed in as the second parameter to
 the script.
index ffcb26f..dc2d9ba 100644 (file)
@@ -35,13 +35,13 @@ a utility like rsync may be used to make them identical.
 .SH OPTIONS
 .B --source=<src>
 .br
-The path to the root of the Lustre filesytem which will be replicated. 
+The path to the root of the Lustre filesystem which will be replicated.
 Mandatory if a valid statuslog created during an previous replication operation
 (--statuslog) is not specified.
 
 .B --target=<tgt>
 .br
-The path to the root where the filesystem we be replicated. Mandatory
+The path to the root where the filesystem will be replicated. Mandatory
 if a valid statuslog created during an previous replication operation
 (--statuslog) is not specified. This option can be repeated if
 multiple replication targets are desired.
index ad86ec6..03f1f9d 100644 (file)
@@ -179,7 +179,7 @@ is created.
 Print more information.
 .TP
 .B \-V,  \-\-version
-Output build version of the mkfs.lustre utiltiy.
+Output build version of the mkfs.lustre utility.
 
 .SH NID
 A Lustre network identifier (NID) is used to uniquely identify a Lustre network
@@ -218,7 +218,7 @@ Create zfs pool 'zfspool' on two root vdevs each a mirror of two disks and
 create mdt/mgs on filesystem 'zfspool/mdt1'.
 .TP
 .B mkfs.lustre --version
-Output build version of the mkfs.lustre utiltiy e.g. 2.15.52_175_ge7aa83d
+Output build version of the mkfs.lustre utility e.g. 2.15.52_175_ge7aa83d
 
 .SH AVAILABILITY
 .B mkfs.lustre
index ea4bf5e..3fbc1b7 100644 (file)
@@ -51,7 +51,7 @@ for automatic mount at boot time, is usable like any local filesystem, and
 provides a full POSIX-compilant interface.
 .TP
 .I block_device
-specifies the phyisical disk or ZFS dataset uses to start the target service
+specifies the physical disk or ZFS dataset uses to start the target service
 formatted by the
 .IR mkfs.lustre (8)
 command.  The