Blame 0008-Use-comments-to-separate-sections-in-manual-pages.patch

Anton Arapov 48d35d
From ae28cbb12fc80f62230ad06cb44ad0aaaa9e2048 Mon Sep 17 00:00:00 2001
Anton Arapov 48d35d
From: Jean Delvare <jdelvare@suse.de>
Anton Arapov 48d35d
Date: Tue, 29 Jan 2019 14:11:46 +0100
Anton Arapov 48d35d
Subject: [PATCH 08/18] Use comments to separate sections in manual pages
Anton Arapov 48d35d
Anton Arapov 48d35d
Blank lines are interpreted as actual blank lines in manual pages.
Anton Arapov 48d35d
Use comments instead to visually separate sections. Otherwise an
Anton Arapov 48d35d
extra blank like is inserted before every section.
Anton Arapov 48d35d
Anton Arapov 48d35d
Signed-off-by: Jean Delvare <jdelvare@suse.de>
Anton Arapov 48d35d
---
Anton Arapov 48d35d
 man/biosdecode.8 | 11 ++++++++---
Anton Arapov 48d35d
 man/dmidecode.8  | 18 +++++++++++-------
Anton Arapov 48d35d
 man/ownership.8  | 10 +++++++---
Anton Arapov 48d35d
 man/vpddecode.8  | 12 +++++++-----
Anton Arapov 48d35d
 4 files changed, 33 insertions(+), 18 deletions(-)
Anton Arapov 48d35d
Anton Arapov 48d35d
diff --git a/man/biosdecode.8 b/man/biosdecode.8
Anton Arapov 48d35d
index a96eb68..cf7d4db 100644
Anton Arapov 48d35d
--- a/man/biosdecode.8
Anton Arapov 48d35d
+++ b/man/biosdecode.8
Anton Arapov 48d35d
@@ -1,10 +1,12 @@
Anton Arapov 48d35d
 .TH BIOSDECODE 8 "February 2007" "dmidecode"
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH NAME
Anton Arapov 48d35d
 biosdecode \- \s-1BIOS\s0 information decoder
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH SYNOPSIS
Anton Arapov 48d35d
 .B biosdecode
Anton Arapov 48d35d
 .RB [ OPTIONS ]
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH DESCRIPTION
Anton Arapov 48d35d
 .B biosdecode
Anton Arapov 48d35d
 parses the \s-1BIOS\s0 memory and prints information about all structures (or
Anton Arapov 48d35d
@@ -54,7 +56,7 @@ started its life as a part of
Anton Arapov 48d35d
 .B dmidecode
Anton Arapov 48d35d
 but as more entry point types were added, it was moved to a different
Anton Arapov 48d35d
 program.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH OPTIONS
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-d" ", " "--dev-mem FILE"
Anton Arapov 48d35d
@@ -68,17 +70,20 @@ Display usage information and exit
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-V" ", " "--version"
Anton Arapov 48d35d
 Display the version and exit
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH FILES
Anton Arapov 48d35d
 .I /dev/mem
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH BUGS
Anton Arapov 48d35d
 Most of the time,
Anton Arapov 48d35d
 .B biosdecode
Anton Arapov 48d35d
 prints too much information (you don't really care about addresses)
Anton Arapov 48d35d
 or not enough (because it doesn't follow pointers and has no lookup
Anton Arapov 48d35d
 tables).
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH AUTHORS
Anton Arapov 48d35d
 Alan Cox, Jean Delvare
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH "SEE ALSO"
Anton Arapov 48d35d
 .BR dmidecode (8),
Anton Arapov 48d35d
 .BR mem (4),
Anton Arapov 48d35d
diff --git a/man/dmidecode.8 b/man/dmidecode.8
Anton Arapov 48d35d
index 52100a8..1f6529d 100644
Anton Arapov 48d35d
--- a/man/dmidecode.8
Anton Arapov 48d35d
+++ b/man/dmidecode.8
Anton Arapov 48d35d
@@ -1,10 +1,12 @@
Anton Arapov 48d35d
 .TH DMIDECODE 8 "January 2019" "dmidecode"
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH NAME
Anton Arapov 48d35d
 dmidecode \- \s-1DMI\s0 table decoder
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH SYNOPSIS
Anton Arapov 48d35d
 .B dmidecode
Anton Arapov 48d35d
 .RB [ OPTIONS ]
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH DESCRIPTION
Anton Arapov 48d35d
 .B dmidecode
Anton Arapov 48d35d
 is a tool for dumping a computer's \s-1DMI\s0 (some say \s-1SMBIOS\s0) table
Anton Arapov 48d35d
@@ -58,7 +60,7 @@ displayed value.
Anton Arapov 48d35d
 Decoded values. The information presented of course depends on the type
Anton Arapov 48d35d
 of record. Here, we learn about the board's manufacturer, model, version
Anton Arapov 48d35d
 and serial number.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH OPTIONS
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-d" ", " "--dev-mem FILE"
Anton Arapov 48d35d
@@ -158,10 +160,9 @@ is run on a system with BIOS that boasts new SMBIOS specification, which
Anton Arapov 48d35d
 is not supported by the tool yet, it will print out relevant message in
Anton Arapov 48d35d
 addition to requested data on the very top of the output. Thus informs the
Anton Arapov 48d35d
 output data is not reliable.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH "DMI TYPES"
Anton Arapov 48d35d
 The \s-1SMBIOS\s0 specification defines the following \s-1DMI\s0 types:
Anton Arapov 48d35d
-
Anton Arapov 48d35d
 .TS
Anton Arapov 48d35d
 r l
Anton Arapov 48d35d
 __
Anton Arapov 48d35d
@@ -246,7 +247,7 @@ dmidecode --type 0,13
Anton Arapov 48d35d
 dmidecode --type bios
Anton Arapov 48d35d
 .IP \(bu
Anton Arapov 48d35d
 dmidecode --type BIOS
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH BINARY DUMP FILE FORMAT
Anton Arapov 48d35d
 The binary dump files generated by --dump-bin and read using --from-dump
Anton Arapov 48d35d
 are formatted as follows:
Anton Arapov 48d35d
@@ -255,7 +256,7 @@ The SMBIOS or DMI entry point is located at offset 0x00.
Anton Arapov 48d35d
 It is crafted to hard-code the table address at offset 0x20.
Anton Arapov 48d35d
 .IP \(bu "\w'\(bu'u+1n"
Anton Arapov 48d35d
 The DMI table is located at offset 0x20.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH UUID FORMAT
Anton Arapov 48d35d
 There is some ambiguity about how to interpret the UUID fields prior to SMBIOS
Anton Arapov 48d35d
 specification version 2.6. There was no mention of byte swapping, and RFC 4122
Anton Arapov 48d35d
@@ -269,7 +270,7 @@ compatibility, it was decided to interpret the UUID fields according to RFC
Anton Arapov 48d35d
 4122 (no byte swapping) when the SMBIOS version is older than 2.6, and to
Anton Arapov 48d35d
 interpret the first 3 fields as little-endian (byte-swapped) when the SMBIOS
Anton Arapov 48d35d
 version is 2.6 or later. The Linux kernel follows the same logic.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH FILES
Anton Arapov 48d35d
 .I /dev/mem
Anton Arapov 48d35d
 .br
Anton Arapov 48d35d
@@ -278,11 +279,14 @@ version is 2.6 or later. The Linux kernel follows the same logic.
Anton Arapov 48d35d
 .br
Anton Arapov 48d35d
 .I /sys/firmware/dmi/tables/DMI
Anton Arapov 48d35d
 (Linux only)
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH BUGS
Anton Arapov 48d35d
 More often than not, information contained in the \s-1DMI\s0 tables is inaccurate,
Anton Arapov 48d35d
 incomplete or simply wrong.
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH AUTHORS
Anton Arapov 48d35d
 Alan Cox, Jean Delvare
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH "SEE ALSO"
Anton Arapov 48d35d
 .BR biosdecode (8),
Anton Arapov 48d35d
 .BR mem (4),
Anton Arapov 48d35d
diff --git a/man/ownership.8 b/man/ownership.8
Anton Arapov 48d35d
index f24ef94..71ed788 100644
Anton Arapov 48d35d
--- a/man/ownership.8
Anton Arapov 48d35d
+++ b/man/ownership.8
Anton Arapov 48d35d
@@ -1,10 +1,12 @@
Anton Arapov 48d35d
 .TH OWNERSHIP 8 "February 2005" "dmidecode"
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH NAME
Anton Arapov 48d35d
 ownership \- Compaq ownership tag retriever
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH SYNOPSIS
Anton Arapov 48d35d
 .B ownership
Anton Arapov 48d35d
 .RB [ OPTIONS ]
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH DESCRIPTION
Anton Arapov 48d35d
 .B ownership
Anton Arapov 48d35d
 retrieves and prints the "ownership tag" that can be set on Compaq
Anton Arapov 48d35d
@@ -14,7 +16,7 @@ package,
Anton Arapov 48d35d
 .B ownership
Anton Arapov 48d35d
 doesn't print any version information, nor labels, but only the raw
Anton Arapov 48d35d
 ownership tag. This should help its integration in scripts.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH OPTIONS
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-d" ", " "--dev-mem FILE"
Anton Arapov 48d35d
@@ -25,11 +27,13 @@ Display usage information and exit
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-V" ", " "--version"
Anton Arapov 48d35d
 Display the version and exit
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH FILES
Anton Arapov 48d35d
 .I /dev/mem
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH AUTHOR
Anton Arapov 48d35d
 Jean Delvare
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH "SEE ALSO"
Anton Arapov 48d35d
 .BR biosdecode (8),
Anton Arapov 48d35d
 .BR dmidecode (8),
Anton Arapov 48d35d
diff --git a/man/vpddecode.8 b/man/vpddecode.8
Anton Arapov 48d35d
index c9e4acf..1cc2b76 100644
Anton Arapov 48d35d
--- a/man/vpddecode.8
Anton Arapov 48d35d
+++ b/man/vpddecode.8
Anton Arapov 48d35d
@@ -1,10 +1,12 @@
Anton Arapov 48d35d
 .TH VPDDECODE 8 "February 2007" "dmidecode"
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH NAME
Anton Arapov 48d35d
 vpddecode \- \s-1VPD\s0 structure decoder
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH SYNOPSIS
Anton Arapov 48d35d
 .B vpddecode
Anton Arapov 48d35d
 .RB [ OPTIONS ]
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH DESCRIPTION
Anton Arapov 48d35d
 .B vpddecode
Anton Arapov 48d35d
 prints the "vital product data" information that can be found in almost
Anton Arapov 48d35d
@@ -17,19 +19,17 @@ Box Serial Number
Anton Arapov 48d35d
 Motherboard Serial Number
Anton Arapov 48d35d
 .IP \(bu
Anton Arapov 48d35d
 Machine Type/Model
Anton Arapov 48d35d
-
Anton Arapov 48d35d
 .PP
Anton Arapov 48d35d
 Some systems have these additional items:
Anton Arapov 48d35d
 .IP \(bu "\w'\(bu'u+1n"
Anton Arapov 48d35d
 BIOS Release Date
Anton Arapov 48d35d
 .IP \(bu
Anton Arapov 48d35d
 Default Flash Image File Name
Anton Arapov 48d35d
-
Anton Arapov 48d35d
 .PP
Anton Arapov 48d35d
 Note that these additional items are not documented by IBM, so this is
Anton Arapov 48d35d
 guess work, and as such should not be blindly trusted. Feedback about
Anton Arapov 48d35d
 the accuracy of these labels is welcome.
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH OPTIONS
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-d" ", " "--dev-mem FILE"
Anton Arapov 48d35d
@@ -62,11 +62,13 @@ Display usage information and exit
Anton Arapov 48d35d
 .TP
Anton Arapov 48d35d
 .BR "-V" ", " "--version"
Anton Arapov 48d35d
 Display the version and exit
Anton Arapov 48d35d
-
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH FILES
Anton Arapov 48d35d
 .I /dev/mem
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH AUTHOR
Anton Arapov 48d35d
 Jean Delvare
Anton Arapov 48d35d
+.\"
Anton Arapov 48d35d
 .SH "SEE ALSO"
Anton Arapov 48d35d
 .BR biosdecode (8),
Anton Arapov 48d35d
 .BR dmidecode (8),
Anton Arapov 48d35d
-- 
Anton Arapov 48d35d
2.24.0
Anton Arapov 48d35d