diff options
author | Alejandro Colomar <alx@kernel.org> | 2022-10-26 01:01:32 +0200 |
---|---|---|
committer | Alejandro Colomar <alx@kernel.org> | 2022-10-29 23:51:29 +0200 |
commit | 22356d97e388c79993c94d43109087d3c8740187 (patch) | |
tree | 3746eae8880200683dc61f1c44d55e3d62649dfd /man4 | |
parent | 4279e42dd98a11b31fa4e1fcebbb00b7a677bb70 (diff) |
Many pages: Use a consistent style for lists
There are different kinds of lists:
Tagged paragraphs
These are fixed in a separate commit (the previous one).
They are used for a list of tags and their descriptions.
An example is this commit message itself.
Ordered lists
Elements are preceeded by a number in parentheses.
These represent a set of steps that have an order.
When there are substeps, they will be numbered like (4.2).
Positional lists
Elements are preceeded by a number in square brackets
(index). These represent fields in a set. The index will
start at:
0 fields of a C data structure, to be consistent
with arrays.
1 fields of a file, to be consistent with tools like
cut(1).
Alternatives list
Elements are preceeded by a letter in parentheses.
These represent a set of (normally) exclusive
alternatives.
Bullet lists
Elements are preceeded by bullet symbols. Anything that
doesn't fit elsewhere usually is covered by this type of
list.
Notes
Not really a list, but the syntax is identical to
"positional lists".
There should always be 2 spaces between the list symbol and the
elements. This doesn't apply to "tagged paragraphs", which use
the default indentation rules.
Reported-by: Mike Frysinger <vapier@gentoo.org>
Cc: <groff@gnu.org>
Acked-by: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man4')
-rw-r--r-- | man4/cciss.4 | 12 | ||||
-rw-r--r-- | man4/fuse.4 | 4 | ||||
-rw-r--r-- | man4/initrd.4 | 40 | ||||
-rw-r--r-- | man4/lirc.4 | 6 | ||||
-rw-r--r-- | man4/loop.4 | 6 | ||||
-rw-r--r-- | man4/rtc.4 | 6 | ||||
-rw-r--r-- | man4/sd.4 | 6 | ||||
-rw-r--r-- | man4/st.4 | 10 |
8 files changed, 45 insertions, 45 deletions
diff --git a/man4/cciss.4 b/man4/cciss.4 index 406c32972..44ddc1c90 100644 --- a/man4/cciss.4 +++ b/man4/cciss.4 @@ -285,10 +285,10 @@ echo "rescan" > /proc/scsi/cciss0/1 .PP This causes the driver to: .RS -.IP 1. 3 +.IP (1) 5 query the adapter about changes to the physical SCSI buses and/or fiber channel arbitrated loop, and -.IP 2. +.IP (2) make note of any new or removed sequential access devices or medium changers. .RE @@ -331,13 +331,13 @@ The .B cciss driver participates in this protocol to some extent. The normal protocol is a four-step process: -.IP * 3 +.IP (1) 5 First, the device is told to abort the command. -.IP * +.IP (2) If that doesn't work, the device is reset. -.IP * +.IP (3) If that doesn't work, the SCSI bus is reset. -.IP * +.IP (4) If that doesn't work, the host bus adapter is reset. .PP The diff --git a/man4/fuse.4 b/man4/fuse.4 index 3eea967e0..2b5385cf5 100644 --- a/man4/fuse.4 +++ b/man4/fuse.4 @@ -471,11 +471,11 @@ operations on the provided filesystem's files and directories to fail with .BR EIO . Among the possible incorrect uses are: .RS -.IP * 3 +.IP \(bu 3 changing .I mode & S_IFMT for an inode that has previously been reported to the kernel; or -.IP * +.IP \(bu giving replies to the kernel that are shorter than what the kernel expected. .RE .TP diff --git a/man4/initrd.4 b/man4/initrd.4 index 4d85929d4..b5132404d 100644 --- a/man4/initrd.4 +++ b/man4/initrd.4 @@ -74,11 +74,11 @@ different device. When booting up with .BR initrd , the system boots as follows: -.IP 1. 3 +.IP (1) 5 The boot loader loads the kernel program and .IR /dev/initrd 's contents into memory. -.IP 2. +.IP (2) On kernel startup, the kernel uncompresses and copies the contents of the device .I /dev/initrd @@ -86,16 +86,16 @@ onto device .I /dev/ram0 and then frees the memory used by .IR /dev/initrd . -.IP 3. +.IP (3) The kernel then read-write mounts the device .I /dev/ram0 as the initial root filesystem. -.IP 4. +.IP (4) If the indicated normal root filesystem is also the initial root filesystem (e.g., .IR /dev/ram0 ) then the kernel skips to the last step for the usual boot sequence. -.IP 5. +.IP (5) If the executable file .I /linuxrc is present in the initial root filesystem, @@ -107,7 +107,7 @@ must have executable permission. The file .I /linuxrc can be any valid executable, including a shell script.) -.IP 6. +.IP (6) If .I /linuxrc is not executed or when @@ -119,7 +119,7 @@ exits with any filesystems mounted on the initial root filesystem, then the behavior of the kernel is .BR UNSPECIFIED . See the NOTES section for the current kernel behavior.) -.IP 7. +.IP (7) If the normal root filesystem has a directory .IR /initrd , the device @@ -150,7 +150,7 @@ when exits, the behavior of the kernel is .BR UNSPECIFIED . See the NOTES section for the current kernel behavior.) -.IP 8. +.IP (8) The usual boot sequence (e.g., invocation of .IR /sbin/init ) is performed on the normal root filesystem. @@ -312,7 +312,7 @@ The main motivation for implementing was to allow for modular kernel configuration at system installation. .PP A possible system installation scenario is as follows: -.IP 1. 3 +.IP (1) 5 The loader program boots from floppy or other media with a minimal kernel (e.g., support for .IR /dev/ram , @@ -320,7 +320,7 @@ The loader program boots from floppy or other media with a minimal kernel and the ext2 filesystem) and loads .I /dev/initrd with a gzipped version of the initial filesystem. -.IP 2. +.IP (2) The executable .I /linuxrc determines what is needed to (1) mount the normal root filesystem @@ -328,17 +328,17 @@ determines what is needed to (1) mount the normal root filesystem distribution media (e.g., CD-ROM, network, tape, ...). This can be done by asking the user, by auto-probing, or by using a hybrid approach. -.IP 3. +.IP (3) The executable .I /linuxrc loads the necessary modules from the initial root filesystem. -.IP 4. +.IP (4) The executable .I /linuxrc creates and populates the root filesystem. (At this stage the normal root filesystem does not have to be a completed system yet.) -.IP 5. +.IP (5) The executable .I /linuxrc sets @@ -347,12 +347,12 @@ unmounts .IR /proc , the normal root filesystem and any other filesystems it has mounted, and then terminates. -.IP 6. +.IP (6) The kernel then mounts the normal root filesystem. -.IP 7. +.IP (7) Now that the filesystem is accessible and intact, the boot loader can be installed. -.IP 8. +.IP (8) The boot loader is configured to load into .I /dev/initrd a filesystem with the set of modules that was used to bring up the system. @@ -361,7 +361,7 @@ a filesystem with the set of modules that was used to bring up the system. can be modified, then unmounted, and finally, the image is written from .I /dev/ram0 to a file.) -.IP 9. +.IP (9) The system is now bootable and additional installation tasks can be performed. .PP @@ -419,7 +419,7 @@ from the CD-ROM. .\" .\" .SH NOTES -.IP 1. 3 +.IP \(bu 3 With the current kernel, any filesystems that remain mounted when .I /dev/ram0 is moved from @@ -430,7 +430,7 @@ continue to be accessible. However, the .I /proc/mounts entries are not updated. -.IP 2. +.IP \(bu With the current kernel, if directory .I /initrd does not exist, then @@ -447,7 +447,7 @@ is fully unmounted, then .I /dev/ram0 will remain in memory. -.IP 3. +.IP \(bu Users of .I /dev/initrd should not depend on the behavior given in the above notes. diff --git a/man4/lirc.4 b/man4/lirc.4 index 57ad34423..d89994cd6 100644 --- a/man4/lirc.4 +++ b/man4/lirc.4 @@ -259,10 +259,10 @@ is 0) timeout packages in .BR LIRC_MODE_MODE2 . The behavior of this operation has varied across kernel versions: .RS -.IP * 3 +.IP \(bu 3 Since Linux 5.17: timeout packages are always enabled and this ioctl is a no-op. -.IP * +.IP \(bu Since Linux 4.16: timeout packages are enabled by default. Each time the @@ -271,7 +271,7 @@ device is opened, the .B LIRC_SET_REC_TIMEOUT operation can be used to disable (and, if desired, to later re-enable) the timeout on the file descriptor. -.IP * +.IP \(bu In Linux 4.15 and earlier: timeout packages are disabled by default, and enabling them (via .BR LIRC_SET_REC_TIMEOUT ) diff --git a/man4/loop.4 b/man4/loop.4 index bcbf88b31..671648c9b 100644 --- a/man4/loop.4 +++ b/man4/loop.4 @@ -199,16 +199,16 @@ can do, .B LOOP_CONFIGURE can also be used to do the following: .RS -.IP * 2 +.IP \(bu 3 set the correct block size immediately by setting .IR loop_config.block_size ; -.IP * +.IP \(bu explicitly request direct I/O mode by setting .B LO_FLAGS_DIRECT_IO in .IR loop_config.info.lo_flags ; and -.IP * +.IP \(bu explicitly request read-only mode by setting .B LO_FLAGS_READ_ONLY in diff --git a/man4/rtc.4 b/man4/rtc.4 index 5859eba74..e72c3e7b1 100644 --- a/man4/rtc.4 +++ b/man4/rtc.4 @@ -66,12 +66,12 @@ requests listed below. .PP Besides tracking the date and time, many RTCs can also generate interrupts -.IP * 3 +.IP \(bu 3 on every clock update (i.e., once per second); -.IP * +.IP \(bu at periodic intervals with a frequency that can be set to any power-of-2 multiple in the range 2 Hz to 8192 Hz; -.IP * +.IP \(bu on reaching a previously specified alarm time. .PP Each of those interrupt sources can be enabled or disabled separately. @@ -31,11 +31,11 @@ where is the number of the physical drive in order of detection, and .I partition_number is as follows: -.IP +3 +.IP \(bu 3 partition 0 is the whole drive -.IP +.IP \(bu partitions 1\(en4 are the DOS "primary" partitions -.IP +.IP \(bu partitions 5\(en8 are the DOS "extended" (or "logical") partitions .PP For example, @@ -886,7 +886,7 @@ the nonrewind SCSI tape devices .\" Several other .\" people have also contributed to the driver. .SH NOTES -.IP 1. 4 +.IP \(bu 3 When exchanging data between systems, both systems have to agree on the physical tape block size. The parameters of a drive after startup @@ -906,26 +906,26 @@ exchanging data with a foreign system. The drawback of this is that a fairly large tape block size has to be used to get acceptable data transfer rates on the SCSI bus. -.IP 2. +.IP \(bu Many programs (e.g., .BR tar (1)) allow the user to specify the blocking factor on the command line. Note that this determines the physical block size on tape only in variable-block mode. -.IP 3. +.IP \(bu In order to use SCSI tape drives, the basic SCSI driver, a SCSI-adapter driver and the SCSI tape driver must be either configured into the kernel or loaded as modules. If the SCSI-tape driver is not present, the drive is recognized but the tape support described in this page is not available. -.IP 4. +.IP \(bu The driver writes error messages to the console/log. The SENSE codes written into some messages are automatically translated to text if verbose SCSI messages are enabled in kernel configuration. -.IP 5. +.IP \(bu The driver's internal buffering allows good throughput in fixed-block mode also with small .BR read (2) |