[Pkg-ofed-commits] [mstflint] 11/22: Fix malformed man pages
Benjamin Drung
bdrung at moszumanska.debian.org
Tue Jan 3 11:57:13 UTC 2017
This is an automated email from the git hooks/post-receive script.
bdrung pushed a commit to branch old
in repository mstflint.
commit 7914462d51a3da573375c8c4fdd9881b611c1c42
Author: Benjamin Drung <benjamin.drung at profitbricks.com>
Date: Tue Aug 16 16:30:54 2016 +0200
Fix malformed man pages
---
.../0005-Fix-section-mismatch-in-man-pages.patch | 106 ++++++
debian/patches/0006-Fix-man-page-errors.patch | 419 +++++++++++++++++++++
debian/patches/series | 2 +
3 files changed, 527 insertions(+)
diff --git a/debian/patches/0005-Fix-section-mismatch-in-man-pages.patch b/debian/patches/0005-Fix-section-mismatch-in-man-pages.patch
new file mode 100644
index 0000000..a8b0c60
--- /dev/null
+++ b/debian/patches/0005-Fix-section-mismatch-in-man-pages.patch
@@ -0,0 +1,106 @@
+From ad676810797edf91ccdbea13c868cfb865ce9c4a Mon Sep 17 00:00:00 2001
+From: Benjamin Drung <benjamin.drung at profitbricks.com>
+Date: Tue, 9 Aug 2016 17:31:24 +0200
+Subject: Fix section mismatch in man pages
+
+A man page usually should contain a .TH header, specifying the
+section. The section in this manpage doesn't match with the section in
+the filename.
+
+Refer to the groff_man(7) manual page and the man(1) manual page for
+details.
+---
+ man/mstconfig.1 | 2 +-
+ man/mstflint.1 | 2 +-
+ man/mstmcra.1 | 2 +-
+ man/mstmread.1 | 2 +-
+ man/mstmtserver.1 | 2 +-
+ man/mstmwrite.1 | 2 +-
+ man/mstregdump.1 | 2 +-
+ man/mstvpd.1 | 2 +-
+ 8 files changed, 8 insertions(+), 8 deletions(-)
+
+diff --git a/man/mstconfig.1 b/man/mstconfig.1
+index 9c600af..0a24bda 100644
+--- a/man/mstconfig.1
++++ b/man/mstconfig.1
+@@ -1,4 +1,4 @@
+-.TH MSTCONFIG "4.4.0" "" ""
++.TH MSTCONFIG "1" "4.4.0" ""
+ .SH NAME
+ mstconfig
+ .IP
+diff --git a/man/mstflint.1 b/man/mstflint.1
+index 4e87267..5050cf0 100644
+--- a/man/mstflint.1
++++ b/man/mstflint.1
+@@ -1,5 +1,5 @@
+ .\"Text automatically generated by txt2man
+-.TH mstflint 4.4.0 "May 2016" "" ""
++.TH mstflint "1" "4.4.0" "May 2016" ""
+ .SH NAME
+ \fBmstflint \fP- Flash Interface
+ .SH SYNOPSIS
+diff --git a/man/mstmcra.1 b/man/mstmcra.1
+index 102597c..e6ec02d 100644
+--- a/man/mstmcra.1
++++ b/man/mstmcra.1
+@@ -1,4 +1,4 @@
+-.TH MSTMCRA "4.4.0" "" ""
++.TH MSTMCRA "1" "4.4.0" ""
+ .SH NAME
+ mstmcra
+ .IP
+diff --git a/man/mstmread.1 b/man/mstmread.1
+index 5946cc1..2c3adfc 100644
+--- a/man/mstmread.1
++++ b/man/mstmread.1
+@@ -1,4 +1,4 @@
+-.TH MSTMREAD "4.4.0" "" ""
++.TH MSTMREAD "1" "4.4.0" ""
+ .SH NAME
+ mstmread
+ .IP
+diff --git a/man/mstmtserver.1 b/man/mstmtserver.1
+index 885bf49..7135e3b 100644
+--- a/man/mstmtserver.1
++++ b/man/mstmtserver.1
+@@ -1,4 +1,4 @@
+-.TH MSTMTSERVER "4.4.0" "" ""
++.TH MSTMTSERVER "1" "4.4.0" ""
+ .SH NAME
+ mstmtserver
+ .IP
+diff --git a/man/mstmwrite.1 b/man/mstmwrite.1
+index 9a1464d..3d89bb6 100644
+--- a/man/mstmwrite.1
++++ b/man/mstmwrite.1
+@@ -1,4 +1,4 @@
+-.TH MSTMWRITE "4.4.0" "" ""
++.TH MSTMWRITE "1" "4.4.0" ""
+ .SH NAME
+ mstmwrite
+ .IP
+diff --git a/man/mstregdump.1 b/man/mstregdump.1
+index bf29abd..3963e81 100644
+--- a/man/mstregdump.1
++++ b/man/mstregdump.1
+@@ -1,4 +1,4 @@
+-.TH MSTREGDUMP "4.4.0" "" ""
++.TH MSTREGDUMP "1" "4.4.0" ""
+ .SH NAME
+ mstregdump
+ .IP
+diff --git a/man/mstvpd.1 b/man/mstvpd.1
+index 2f69f81..72a4ee3 100644
+--- a/man/mstvpd.1
++++ b/man/mstvpd.1
+@@ -1,4 +1,4 @@
+-.TH MSTVPD "4.4.0" "" ""
++.TH MSTVPD "1" "4.4.0" ""
+ .SH NAME
+ mstvpd
+ .IP
+--
+2.7.4
+
diff --git a/debian/patches/0006-Fix-man-page-errors.patch b/debian/patches/0006-Fix-man-page-errors.patch
new file mode 100644
index 0000000..8bf2c1c
--- /dev/null
+++ b/debian/patches/0006-Fix-man-page-errors.patch
@@ -0,0 +1,419 @@
+From bf9daf9b6dfe968b4637887337a0173d25348922 Mon Sep 17 00:00:00 2001
+From: Benjamin Drung <benjamin.drung at profitbricks.com>
+Date: Tue, 9 Aug 2016 17:49:31 +0200
+Subject: Fix man page errors
+
+---
+ man/mstconfig.1 | 6 +++---
+ man/mstflint.1 | 55 ++++++++++++++++++++++++++++---------------------------
+ man/mstmcra.1 | 7 ++-----
+ man/mstmread.1 | 6 ++----
+ man/mstmtserver.1 | 7 +++----
+ man/mstmwrite.1 | 4 +---
+ man/mstregdump.1 | 9 +++------
+ man/mstvpd.1 | 6 ++----
+ 8 files changed, 44 insertions(+), 56 deletions(-)
+
+diff --git a/man/mstconfig.1 b/man/mstconfig.1
+index 0a24bda..30b119d 100644
+--- a/man/mstconfig.1
++++ b/man/mstconfig.1
+@@ -2,11 +2,11 @@
+ .SH NAME
+ mstconfig
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+ mstconfig [\-d <mst device> ] [\-y|\-e] <s[et] <parameters to set>|q[uery]|r[eset]>
+ .IP
+-.SH OPTIONS:
++.SH OPTIONS
+ .TP
+ \fB\-d\fR|\-\-dev <device>
+ : Perform operation for a specified mst device.
+@@ -216,7 +216,7 @@ LINK_TYPE_P1=<ETH|IB|VPI>
+ .IP
+ LINK_TYPE_P2=<ETH|IB|VPI>
+ .IP
+-\fBWake On LAN:\R
++\fBWake On LAN:\fR
+ .IP
+ WOL_MAGIC_EN=<False|True>
+ .IP
+diff --git a/man/mstflint.1 b/man/mstflint.1
+index 5050cf0..a54fa83 100644
+--- a/man/mstflint.1
++++ b/man/mstflint.1
+@@ -427,7 +427,7 @@ mstflint \fB-d\fP 04:00.0 \fB-i\fP image1.bin burn
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 \fB-guid\fP 0x2c9000100d050 \fB-i\fP image1.bin b
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -446,7 +446,7 @@ Display FW Version, GUIDs, PSID, and other info.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 query
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -463,7 +463,7 @@ mstflint \fB-d\fP 04:00.0 query
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 v
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -480,7 +480,7 @@ This command is supported only in the In-Band access method.
+ .IP
+ \fIExamples\fP: None
+
+-."***************************************************************************************
++\"***************************************************************************************
+ .RE
+ .TP
+ .B
+@@ -496,7 +496,7 @@ This command is supported only in the In-Band access method.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 brom exp-rom.rom
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -513,7 +513,7 @@ mstflint \fB-d\fP 04:00.0 brom exp-rom.rom
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 drom
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -530,7 +530,7 @@ mstflint \fB-d\fP 04:00.0 drom
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 rrom exp-rom.rom
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -549,7 +549,7 @@ on the given image file. No fields (such as VSD or Guids) are read from flash.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 \fB-i\fP image1.bin bb
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -588,7 +588,7 @@ mstflint \fB-d\fP 04:00.0 \fB-guid\fP 0x0002c9000100d050 sg
+ .IP \(bu 4
+ mstflint -d 08:00.0 -guid 0x0002c9000100d050 -mac 0x0002c900d050 sg
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -605,11 +605,11 @@ mstflint -d 08:00.0 -guid 0x0002c9000100d050 -mac 0x0002c900d050 sg
+ .IP \(bu 4
+ mstflint \fB-i\fP fw_image.bin set_vpd vpd.bin
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+-.b
++.B
+ \fIName\fP: sv
+ .IP
+ \fIDescription\fP: Set VSD in the given device/image.
+@@ -624,7 +624,7 @@ Use \fB-vsd\fP flag to set the desired VSD string.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 \fB-vsd\fP VSD_STRING sv
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -641,7 +641,7 @@ mstflint \fB-d\fP 04:00.0 \fB-vsd\fP VSD_STRING sv
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 ri file.bin
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -662,7 +662,7 @@ section depends on the version of the image generation tool.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 dc
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -680,7 +680,7 @@ This command would fail if the image does not contain a Hash file.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 dh hash.csv
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -697,7 +697,7 @@ mstflint \fB-d\fP 04:00.0 dh hash.csv
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 set_key 1234deaf5678
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -719,7 +719,7 @@ key: (optional) The key you intend to use for enabling the HW access.
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 hw_access enable
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -752,7 +752,7 @@ mstflint \fB-d\fP 04:00.0 hw set QuadEn=1
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 hw set Flash1.WriteProtected=Top,1-SubSectors
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -769,7 +769,7 @@ mstflint \fB-d\fP 04:00.0 hw set Flash1.WriteProtected=Top,1-SubSectors
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 erase 0x10000
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -786,7 +786,7 @@ mstflint \fB-d\fP 04:00.0 erase 0x10000
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 rw 0x20
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -809,7 +809,7 @@ data - value of word
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 ww 0x10008 0x5a445a44
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -836,7 +836,7 @@ data - value of word
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 wwne 0x10008 0x5a445a44
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -857,7 +857,7 @@ Examples:
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 wbne 0x10000 12 0x30000 0x76800 0x5a445a44
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -876,7 +876,7 @@ addr - address to write the block to
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 wb myData.bin 0x0
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -894,11 +894,12 @@ Read a data block from the flash and write it to a file or to screen.
+ size - size of data to read in bytes
+ .IP
+ file - filename to write the block (raw binary). If not given, the data is printed to screen.
++.IP
+ \fIExamples\fP:
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 rb 0x10000 100 file.bin
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -914,7 +915,7 @@ mstflint \fB-d\fP 04:00.0 rb 0x10000 100 file.bin
+ \fIExamples\fP:
+ .IP \(bu 4
+ mstflint \fB-i\fP fw_image.bin qrom
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+@@ -931,7 +932,7 @@ mstflint \fB-i\fP fw_image.bin qrom
+ .IP \(bu 4
+ mstflint \fB-d\fP 04:00.0 checksum
+
+-."***************************************************************************************
++\"***************************************************************************************
+
+ .RE
+ .TP
+diff --git a/man/mstmcra.1 b/man/mstmcra.1
+index e6ec02d..aba4d38 100644
+--- a/man/mstmcra.1
++++ b/man/mstmcra.1
+@@ -1,11 +1,9 @@
+ .TH MSTMCRA "1" "4.4.0" ""
+ .SH NAME
+-mstmcra
++mstmcra \- Mellanox Configuration Registers Access tool
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+-Mellanox Configuration Registers Access tool
+-
+ mstmcra [-s <i2c-slave>] [-a <adb dump>] [-v] [-h] <device>
+ <addr[.<bit offset>:<bit size>]|[,<bytes number>]> [data]
+
+@@ -31,4 +29,3 @@ mstmcra [-s <i2c-slave>] [-a <adb dump>] [-v] [-h] <device>
+ .SH Environment Vairables:
+ .TP
+ ADB_DUMP : Holds the path to adb dump, used for access by path (can be overridden by "\-a").
+-.TP
+diff --git a/man/mstmread.1 b/man/mstmread.1
+index 2c3adfc..4630c97 100644
+--- a/man/mstmread.1
++++ b/man/mstmread.1
+@@ -1,10 +1,8 @@
+ .TH MSTMREAD "1" "4.4.0" ""
+ .SH NAME
+-mstmread
++mstmread \- Mellanox Read Configuration Register Tool
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+-Mellanox Read Configuration Register Tool
+-
+ mstmread <device> <addr>
+ .IP
+diff --git a/man/mstmtserver.1 b/man/mstmtserver.1
+index 7135e3b..b4f2a66 100644
+--- a/man/mstmtserver.1
++++ b/man/mstmtserver.1
+@@ -1,16 +1,15 @@
+ .TH MSTMTSERVER "1" "4.4.0" ""
+ .SH NAME
+-mstmtserver
++mstmtserver \- Mellanox Software tools (mst) server (remote mtcr calls)
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+ mstmtserver [options]
+ .IP
+-.SH OPTIONS:
++.SH OPTIONS
+ .TP
+ \fB-p\fR[ort] <port> - Listen to specify port (default is 23108).
+ .TP
+ \fB-d\fR[ebug] - Print all socket traffic (for debugging only).
+ .TP
+ \fB-h\fR[elp] - Print help message.
+-.TP
+diff --git a/man/mstmwrite.1 b/man/mstmwrite.1
+index 3d89bb6..7401181 100644
+--- a/man/mstmwrite.1
++++ b/man/mstmwrite.1
+@@ -1,10 +1,8 @@
+ .TH MSTMWRITE "1" "4.4.0" ""
+ .SH NAME
+-mstmwrite
++mstmwrite \- Mellanox Write Configuration Register Tool
+ .IP
+ .SH SYNOPSIS:
+ .IP
+-Mellanox Write Configuration Register Tool
+-
+ mstmread <device> <addr> <value>
+ .IP
+diff --git a/man/mstregdump.1 b/man/mstregdump.1
+index 3963e81..e27bbb4 100644
+--- a/man/mstregdump.1
++++ b/man/mstregdump.1
+@@ -1,14 +1,12 @@
+ .TH MSTREGDUMP "1" "4.4.0" ""
+ .SH NAME
+-mstregdump
++mstregdump \- Mellanox mstdump utility, dumps device internal configuration data
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+-Mellanox mstdump utility, dumps device internal configuration data
+-
+ mstregdump [-full] <device> [i2c-slave] [-v[ersion] [-h[elp]]]
+ .IP
+-.SH OPTIONS:
++.SH OPTIONS
+ .TP
+ \fB-full\fR : Dump more expanded list of addresses
+ \fBNote\fR : be careful when using this flag, None safe addresses might be read.
+@@ -20,4 +18,3 @@ mstregdump [-full] <device> [i2c-slave] [-v[ersion] [-h[elp]]]
+ .SH EXAMPLE:
+ .TP
+ mstregdump 04:00.0
+-.TP
+diff --git a/man/mstvpd.1 b/man/mstvpd.1
+index 72a4ee3..4df6a11 100644
+--- a/man/mstvpd.1
++++ b/man/mstvpd.1
+@@ -1,11 +1,9 @@
+ .TH MSTVPD "1" "4.4.0" ""
+ .SH NAME
+-mstvpd
++mstvpd \- Mellanox VPD read tool
+ .IP
+-.SH SYNOPSIS:
++.SH SYNOPSIS
+ .IP
+-Mellanox VPD read tool
+-
+ mstvpd [-m|-n] [-t ##] <file> [\-- keyword ...]
+ .IP
+ .SH OPTIONS:
+--
+2.7.4
+
diff --git a/debian/patches/series b/debian/patches/series
index 09feeb7..732c99d 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -2,3 +2,5 @@
0002-Fix-typo-allign-align.patch
0003-Fix-typo-missmatch-mismatch.patch
0004-Fix-other-typos.patch
+0005-Fix-section-mismatch-in-man-pages.patch
+0006-Fix-man-page-errors.patch
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ofed/mstflint.git
More information about the Pkg-ofed-commits
mailing list