Browse Source

fix whitespace issue in ducumentation

This removes trailing whitespaces and fixes minor issues.
pull/1307/head
Christian Hesse 1 year ago
parent
commit
e08e3d587c
  1. 4
      Documentation/TODO
  2. 41
      Documentation/releases/v2.35-ReleaseNotes
  3. 12
      Documentation/releases/v2.36-ReleaseNotes
  4. 46
      Documentation/releases/v2.37-ReleaseNotes
  5. 2
      libblkid/libblkid.3.adoc
  6. 2
      login-utils/runuser.1.adoc
  7. 8
      man-common/README.md
  8. 2
      man-common/manpage-stub.adoc
  9. 10
      misc-utils/logger.1.adoc
  10. 2
      misc-utils/whereis.1.adoc
  11. 2
      po-man/README.md
  12. 4
      sys-utils/chcpu.8.adoc
  13. 2
      sys-utils/fstrim.8.adoc
  14. 2
      sys-utils/lscpu.1.adoc
  15. 4
      sys-utils/mount.8.adoc
  16. 1
      term-utils/script.1.adoc
  17. 2
      text-utils/ul.1.adoc

4
Documentation/TODO

@ -19,7 +19,7 @@ tests
fstrim
------
- "fstrim --fstab" uses root= from /proc/cmdline to get root FS when it's missing
in fstab file. This is fragile (due to missing root= or the root FS is not
in fstab file. This is fragile (due to missing root= or the root FS is not
accessible). The best seems to parse mountinfo and use mnt_table_get_root_fs()
as a fallback solution. https://github.com/karelzak/util-linux/issues/1266.
@ -137,7 +137,7 @@ libsmartcols / column -t
- add support for border of table
* extend 'struct libscols_symbols', use box-drawing chars UTF8/ASCII
* add scols_table_enable_border()
libblkid
--------

41
Documentation/releases/v2.35-ReleaseNotes

@ -7,54 +7,53 @@ Release highlights
agetty(8) now provides a new command-line option --show-issue to print issue
file(s) on the current terminal in the same way how it will be printed when
agetty(8) executed regularly.
agetty(8) supports /run/issue and /usr/lib/issue files and directrories now.
dmesg(1) escapes unprintable and potentially unsafe characters by default. The
new command-line option --noescape disables this feature.
kill(1) now uses pidfd kernel feature to implement a new command-line option
--timeout. The option allows sending a sequence of follow-up signals with
defined timeouts without the possibility of race.
defined timeouts without the possibility of race.
script(1) now used the same PTY code as su(1) --pty. script(1) has also been
massively extended to support new logging features like log signals, stdin or
additional session information. The new features are implemented by the new
timing file format. The changes are backwardly compatible, and the original
timing file format is still the default.
timing file format is still the default.
scriptreplay(1) now allows to extract stdin or session summary from script(1)
logs.
scriptlive(1) this NEW COMMAND re-execute stdin log by a shell in PTY session.
scriptlive(1) this NEW COMMAND re-execute stdin log by a shell in PTY session.
mount(8) and libmount now provides built-in dm-verity support if linked with
libcryptsetup. This new feature is EXPERIMENTAL and disabled by default; use
--with-cryptsetup to enable.
--with-cryptsetup to enable.
libmount now uses poll() syscall to verify /proc/self/mountinfo file consistence
and it re-read the file if modified during previous read call.
and it re-read the file if modified during previous read call.
mount(8) now provides a new command-line option --target-prefix to mount, for
example, fstab to an alternative location. This feature is usable, for example,
for chroots or containers.
for chroots or containers.
mount(8) now allows to use -o together with --all, for example, "mount --all
-o ro --target-prefix /foo" will mount real-only all filesystems from fstab to
/foo.
/foo.
lsblk(8) provides new columns FSVER (filesystem version) and PARTTYPENAME
(human-readable partition type).
lsblk(8) reads device properties from /dev/<devname> text file when executed
with --sysroot. This is usable for tests and dumps.
sfdisk(8) uses progress bar for --move-data and data move is now significantly
faster than in previous versions as it does not use fsync during the data move
(use --move-use-fsync to disable this feature).
Changes between v2.34 and v2.35
-------------------------------

12
Documentation/releases/v2.36-ReleaseNotes

@ -1,6 +1,6 @@
Util-linux 2.36 Release Notes
=============================
Release highlights
------------------
@ -34,14 +34,14 @@ information about partition table. Another new command line option is
on empty devices.
The command fdisk(8) and sfdisk(8) support user-friendly aliases for partition
types. For example "echo 'size=10M type=uefi' | sfdisk /dev/sda" creates EFI
types. For example "echo 'size=10M type=uefi' | sfdisk /dev/sda" creates EFI
system partition on sda.
fstrim(8) supports new command line option --listed-in to specify alternatives
fstrim(8) supports new command line option --listed-in to specify alternatives
where to read list of the filesystems. This option makes fstrim systemd service
file more portable between distributions.
libfdisk provides API to relocate GPT backup header. This feature is usable to
libfdisk provides API to relocate GPT backup header. This feature is usable to
generate small, but still valid images for containers and resize the image later.
This new feature is exported to command line by "sfdisk --relocate".
@ -56,7 +56,7 @@ option MOTD_FILE= in /etc/login.defs now. The default value is
All tools which read /etc/login.defs is possible to compile with libeconf now.
The build system provides a new option --disable-hwclock-gplv3 to avoid optional
The build system provides a new option --disable-hwclock-gplv3 to avoid optional
GPLv3 code in the command hwclock(8).
The build system supports a new option --with-cryptsetup=dlopen to use dlopen
@ -68,7 +68,7 @@ default.
more(1) has been refactored to meet 21st century codding standards. Thanks to
Sami Kerola.
Thanks to Michael Kerrisk for massive man pages cleanup, and thanks to Evgeny
Thanks to Michael Kerrisk for massive man pages cleanup, and thanks to Evgeny
Vereshchagin for work on better integration with CIFuzz and Travis.

46
Documentation/releases/v2.37-ReleaseNotes

@ -1,55 +1,55 @@
Util-linux 2.37 Release Notes
=============================
Release highlights
------------------
This project no more uses Groff to maintain man-pages. Since v2.37 all text is
maintained in AsciiDoc and man-pages are generated by asciidoctor to man-pages
during the package build process (see also --disable-asciidoc configure
option). Thanks to Mario Blättermann.
option). Thanks to Mario Blättermann.
The long-term goal is to maintain also man-page translations (via
translationproject.org and po4a) in the util-linux project. Please, contact
Mario Blättermann if you're want to help with the conversion from
manpages-l10n.
The old hardlink(1) implementation from Jakub Jelinek (originally for Fedora)
has been replaced by a new implementation from Julian Andres Klode (originally
for Debian). The new implementation does not support -f option to force
hardlinks creation between filesystem.
hardlinks creation between filesystem.
lscpu(1) has been reimplemented. Now it analyzes /sys for all CPUs and provides
information for all CPU types used by the system (for example heterogeneous
big.LITTLE ARMs, etc.). This command reads also SMBIOS tables to get CPU
identifiers. Thanks to Masayoshi Mizuma from Fujitsu and Jeffrey Bastian from
Red Hat. The default output on the terminal is more structured now to be more
human-readable.
human-readable.
uclampset(1) is new util to manipulate the utilization clamping attributes of
the system or a process. Thanks to Qais Yousef from ARM.
hexdump(1) automatically uses -C when called as "hd".
dmesg(1) supports new command-line options --since and --until.
findmnt(8) supports new command-line options --shadowed to print only
filesystems over-mounted by another filesystem.
filesystems over-mounted by another filesystem.
mount(8) supports --read-only command-line option for non-root users too.
umount(8) can umount also all over-mounted filesystems (more filesystems on the
the same mount point) when executed with --recursive.
libfdisk (and fdisk, sfdisk, cfdisk) supports partition type names on input,
ignoring the case of the characters and all non-alphanumeric and non-digit
characters in the name (e.g. type="Linux /usr x86" is the same as type="linux
usr-x86" for sfdisk).
usr-x86" for sfdisk).
libmount no more contains a workaround to detect inconsistent
/proc/self/mountinfo read. This problem is fixed by the Linux kernel (since v5.8,
kernel commit 9f6c61f96f2d97cbb5f7fa85607bc398f843ff0f).
libblkid supports "probing hints" now. The hints are the optional way how to
force probing functions to check for example another location -- for example
specific session on multi-session UDF. The command blkid(8) supports this
@ -57,21 +57,21 @@ functionality with a new --hint option. The library has been also extended to
support others ISO9660 and UDF identifiers. Thanks to Pali Rohár.
blkzone(8) provides a new "capacity" command.
cfdisk(8) is possible to start in read-only mode by a new command-line option
--read-only
lsblk(8) provides new columns FSROOTS, and MOUNTTARGETS. The column
MOUNTTARGETS is used in the default output now and this new column prints all
mount points where the device is used (btrfs subvolumes, bind mounts, etc).
losetup(8) uses LOOP_CONFIG ioctl now.
column(1) supports a new command-line option --table-columns-limit to specify a
maximal number of the input columns. The last column will contain all remaining
line data if the limit is smaller than the number of the columns in the input
data.
It's possible to use meson to build util-linux. This feature is experimental
and currently designed only for developers. No panic, the current primary
autotools-based build process will be supported, maintained, and used as

2
libblkid/libblkid.3.adoc

@ -55,7 +55,7 @@ The low-level probing code was rewritten by Karel Zak.
== SEE ALSO
*blkid*(8),
*blkid*(8),
*findfs*(8)
include::man-common/bugreports.adoc[]

2
login-utils/runuser.1.adoc

@ -45,7 +45,7 @@ Specify a supplementary group. This option is available to the root user only. T
*-*, *-l*, *--login*::
Start the shell as a login shell with an environment similar to a real login:
+
* clears all the environment variables except for *TERM* and variables specified by *--whitelist-environment*
* clears all the environment variables except for *TERM* and variables specified by *--whitelist-environment*
* initializes the environment variables *HOME*, *SHELL*, *USER*, *LOGNAME*, and *PATH*
* changes to the target user's home directory
* sets argv[0] of the shell to '*-*' in order to make the shell a login shell

8
man-common/README.md

@ -1,6 +1,6 @@
# Working with the Asciidoc files
To get the groff version from an asciidoc man page (example for a dummy man page filename.1.adoc):
To get the groff version from an asciidoc man page (example for a dummy man page filename.1.adoc):
asciidoctor -b manpage \
-a release-version=2.37 \
@ -9,12 +9,12 @@ To get the groff version from an asciidoc man page (example for a dummy man page
-a runstatedir=/run \
-D output_directory \
filename.1.adoc
To get the translated versions, add an extra option which includes translation.adoc:
-a translation
The "-a" options are applicable to certain man pages. However, if the mentioned
variable is unused, they don't produce an error message.
variable is unused, they don't produce an error message.
The footers of the asciidoc files already contain relative paths to the files in man-common.

2
man-common/manpage-stub.adoc

@ -33,7 +33,7 @@ Describe *foobar* briefly.
== OPTIONS
//Format options bold and values italic:
//Format options bold and values italic:
*-o*, *--option* _value_::
This option has a value.
+

10
misc-utils/logger.1.adoc

@ -143,11 +143,11 @@ Specifies a structured data element ID for an RFC 5424 message header. The optio
Specifies a structured data element parameter, a name and value pair. The option has to be used after *--sd-id* and may be specified more than once for the same element. Note that the quotation marks around _value_ are required and must be escaped on the command line.
+
....
logger --rfc5424 --sd-id zoo@123 \
logger --rfc5424 --sd-id zoo@123 \
--sd-param tiger="hungry" \
--sd-param zebra="running" \
--sd-id manager@123
--sd-param onMeeting="yes"
--sd-id manager@123 \
--sd-param onMeeting="yes" \
"this is message"
....
produces:
@ -203,14 +203,14 @@ Valid facility names are:
*kern* cannot be generated from userspace process, automatically converted to *user* +
*lpr* +
*mail* +
*mail* +
*news* +
*syslog* +
*user* +
*uucp* +
*local0* +
to +
*local7* +
*local7* +
*security* deprecated synonym for *auth*
Valid level names are:

2
misc-utils/whereis.1.adoc

@ -99,7 +99,7 @@ Output the list of effective lookup paths that *whereis* is using. When none of
*-h*, *--help*::
Display help text and exit.
*-V*, *--version*::
Display version information and exit.

2
po-man/README.md

@ -15,7 +15,7 @@ better readability.
This is done in one step using the following simple command:
po4a po4a.cfg
If there's something wrong with a .po file, the command will fail. In any case,
have a look at the first line of po4a.cfg if all of the mentioned files are
present.

4
sys-utils/chcpu.8.adoc

@ -40,10 +40,10 @@ Deconfigure the specified CPUs. Deconfiguring a CPU means that the hypervisor re
*-p*, *--dispatch* _mode_::
Set the CPU dispatching _mode_ (polarization). This option has an effect only if your hardware architecture and hypervisor support CPU polarization. Available _modes_ are:
*horizontal*;;
The workload is spread across all available CPUs.
*vertical*;;
The workload is concentrated on few CPUs.

2
sys-utils/fstrim.8.adoc

@ -55,7 +55,7 @@ Minimum contiguous free range to discard, in bytes. (This value is internally ro
Verbose execution. With this option *fstrim* will output the number of bytes passed from the filesystem down the block stack to the device for potential discard. This number is a maximum discard amount from the storage device's perspective, because _FITRIM_ ioctl called repeated will keep sending the same sectors for discard repeatedly.
+
*fstrim* will report the same potential discard bytes each time, but only sectors which had been written to between the discards would actually be discarded by the storage device. Further, the kernel block layer reserves the right to adjust the discard ranges to fit raid stripe geometry, non-trim capable devices in a LVM setup, etc. These reductions would not be reflected in fstrim_range.len (the *--length* option).
*--quiet-unsupported*::
Suppress error messages if trim operation (ioctl) is unsupported. This option is meant to be used in systemd service file or in cron scripts to hide warnings that are result of known problems, such as NTFS driver reporting _Bad file descriptor_ when device is mounted read-only, or lack of file system support for ioctl FITRIM call.

2
sys-utils/lscpu.1.adoc

@ -120,7 +120,7 @@ Display help text and exit.
Use JSON output format for the default summary or extended output (see *--extended*).
*-p*, *--parse*[=_list_]::
Optimize the command output for easy parsing.
Optimize the command output for easy parsing.
+
If the _list_ argument is omitted, the command output is compatible with earlier versions of *lscpu*. In this compatible format, two commas are used to separate CPU cache columns. If no CPU caches are identified the cache column is omitted. If the _list_ argument is used, cache columns are separated with a colon (:).
+

4
sys-utils/mount.8.adoc

@ -44,7 +44,7 @@ mount - mount a filesystem
== SYNOPSIS
*mount* [*-h*|*-V*]
*mount* [*-l*] [*-t* _fstype_]
*mount* *-a* [*-fFnrsvw*] [*-t* _fstype_] [*-O* _optlist_]
@ -474,7 +474,7 @@ Two other options are *fscontext=* and *defcontext=*, both of which are mutually
+
The *fscontext=* option works for all filesystems, regardless of their xattr support. The fscontext option sets the overarching filesystem label to a specific security context. This filesystem label is separate from the individual labels on the files. It represents the entire filesystem for certain kinds of permission checks, such as during mount or file creation. Individual file labels are still obtained from the xattrs on the files themselves. The context option actually sets the aggregate context that fscontext provides, in addition to supplying the same label for individual files.
+
You can set the default security context for unlabeled files using *defcontext=* option. This overrides the value set for unlabeled files in the policy and requires a filesystem that supports xattr labeling.
You can set the default security context for unlabeled files using *defcontext=* option. This overrides the value set for unlabeled files in the policy and requires a filesystem that supports xattr labeling.
+
The *rootcontext=* option allows you to explicitly label the root inode of a FS being mounted before that FS or inode becomes visible to userspace. This was found to be useful for things like stateless Linux.
+

1
term-utils/script.1.adoc

@ -102,7 +102,6 @@ Log timing information to the _file_. Two timing file formats are supported now.
*-m*, *--logging-format* _format_::
Force use of _advanced_ or _classic_ format. The default is the classic format to log only output and the advanced format when input as well as output logging is requested.
*Classic format*:::
The log contains two fields, separated by a space. The first field indicates how much time elapsed since the previous output. The second field indicates how many characters were output this time.

2
text-utils/ul.1.adoc

@ -83,7 +83,7 @@ The *ul* command appeared in 3.0BSD.
== SEE ALSO
*colcrt*(1),
*colcrt*(1),
*login*(1),
*man*(1),
*nroff*(1),

Loading…
Cancel
Save