0001-Fix-bad-whatis-entries-in-man-pages.patch 10.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
From: Benjamin Drung <benjamin.drung@profitbricks.com>
Date: Mon, 21 Aug 2017 16:40:41 +0200
Subject: [PATCH 1/2] Fix bad whatis entries in man pages

Each manual page should start with a "NAME" section, which lists the
name and a brief description of the page separated by "\-". The "NAME"
section is parsed by lexgrog and used to generate a database that's
queried by commands like apropos and whatis.

Regenerating the man pages with rst2man will cause the man pages to have
malformed whatis entries if the metadata comes before the brief
description in the reStructured text.

Signed-off-by: Benjamin Drung <benjamin.drung@profitbricks.com>
---
 doc/rst/check_lft_balance.8.in.rst |  9 ++++-----
 doc/rst/ibcacheedit.8.in.rst       |  9 ++++-----
 doc/rst/ibfindnodesusing.8.in.rst  |  9 ++++-----
 doc/rst/ibidsverify.8.in.rst       | 10 +++++-----
 doc/rst/ibroute.8.in.rst           |  9 ++++-----
 doc/rst/ibstat.8.in.rst            |  9 ++++-----
 doc/rst/ibstatus.8.in.rst          |  9 ++++-----
 doc/rst/ibsysstat.8.in.rst         |  9 ++++-----
 doc/rst/ibtracert.8.in.rst         | 10 +++++-----
 doc/rst/infiniband-diags.8.in.rst  |  9 ++++-----
 doc/rst/perfquery.8.in.rst         |  9 ++++-----
 doc/rst/saquery.8.in.rst           |  9 ++++-----
 doc/rst/sminfo.8.in.rst            | 10 +++++-----
 doc/rst/smpdump.8.in.rst           |  9 ++++-----
 doc/rst/smpquery.8.in.rst          |  9 ++++-----
 doc/rst/vendstat.8.in.rst          |  9 ++++-----
 16 files changed, 67 insertions(+), 80 deletions(-)

diff --git a/doc/rst/check_lft_balance.8.in.rst b/doc/rst/check_lft_balance.8.in.rst
index 96c41f2..2639a20 100644
--- a/doc/rst/check_lft_balance.8.in.rst
+++ b/doc/rst/check_lft_balance.8.in.rst
@@ -1,15 +1,14 @@
 =================
-CHECK_LFT_BALANCE
+check_lft_balance
 =================
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 --------------------------------------------------
 check InfiniBand unicast forwarding tables balance
 --------------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibcacheedit.8.in.rst b/doc/rst/ibcacheedit.8.in.rst
index 5d61efb..69028cd 100644
--- a/doc/rst/ibcacheedit.8.in.rst
+++ b/doc/rst/ibcacheedit.8.in.rst
@@ -1,15 +1,14 @@
 ===========
-IBCACHEEDIT
+ibcacheedit
 ===========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ---------------------------
 edit an ibnetdiscover cache
 ---------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibfindnodesusing.8.in.rst b/doc/rst/ibfindnodesusing.8.in.rst
index 573dea9..e3ba0ae 100644
--- a/doc/rst/ibfindnodesusing.8.in.rst
+++ b/doc/rst/ibfindnodesusing.8.in.rst
@@ -1,15 +1,14 @@
 ================
-IBFINDNODESUSING
+ibfindnodesusing
 ================
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 -------------------------------------------------------------------------------
 find a list of end nodes which are routed through the specified switch and port
 -------------------------------------------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibidsverify.8.in.rst b/doc/rst/ibidsverify.8.in.rst
index 3614333..ece8ea0 100644
--- a/doc/rst/ibidsverify.8.in.rst
+++ b/doc/rst/ibidsverify.8.in.rst
@@ -1,15 +1,15 @@
 ===========
-IBIDSVERIFY
+ibidsverify
 ===========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ---------------------------------------------------
 validate IB identifiers in subnet and report errors
 ---------------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
+
 SYNOPSIS
 ========
 
diff --git a/doc/rst/ibroute.8.in.rst b/doc/rst/ibroute.8.in.rst
index 5870de6..4163b80 100644
--- a/doc/rst/ibroute.8.in.rst
+++ b/doc/rst/ibroute.8.in.rst
@@ -1,15 +1,14 @@
 =======
-IBROUTE
+ibroute
 =======
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 -----------------------------------------
 query InfiniBand switch forwarding tables
 -----------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibstat.8.in.rst b/doc/rst/ibstat.8.in.rst
index 3e19b3e..baf2d3d 100644
--- a/doc/rst/ibstat.8.in.rst
+++ b/doc/rst/ibstat.8.in.rst
@@ -1,15 +1,14 @@
 ======
-IBSTAT
+ibstat
 ======
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ------------------------------------------
 query basic status of InfiniBand device(s)
 ------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibstatus.8.in.rst b/doc/rst/ibstatus.8.in.rst
index cfdac68..e2e5b2d 100644
--- a/doc/rst/ibstatus.8.in.rst
+++ b/doc/rst/ibstatus.8.in.rst
@@ -1,15 +1,14 @@
 ========
-IBSTATUS
+ibstatus
 ========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ------------------------------------------
 query basic status of InfiniBand device(s)
 ------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibsysstat.8.in.rst b/doc/rst/ibsysstat.8.in.rst
index 3a7b295..df0764f 100644
--- a/doc/rst/ibsysstat.8.in.rst
+++ b/doc/rst/ibsysstat.8.in.rst
@@ -1,15 +1,14 @@
 =========
-IBSYSSTAT
+ibsysstat
 =========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 --------------------------------------
 system status on an InfiniBand address
 --------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/ibtracert.8.in.rst b/doc/rst/ibtracert.8.in.rst
index 76fe568..021e690 100644
--- a/doc/rst/ibtracert.8.in.rst
+++ b/doc/rst/ibtracert.8.in.rst
@@ -1,15 +1,15 @@
 =========
-IBTRACERT
+ibtracert
 =========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ---------------------
 trace InfiniBand path
 ---------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
+
 SYNOPSIS
 ========
 
diff --git a/doc/rst/infiniband-diags.8.in.rst b/doc/rst/infiniband-diags.8.in.rst
index be77ce3..571d4cc 100644
--- a/doc/rst/infiniband-diags.8.in.rst
+++ b/doc/rst/infiniband-diags.8.in.rst
@@ -1,15 +1,14 @@
 ================
-INFINIBAND-DIAGS
+infiniband-diags
 ================
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ----------------------------------
 Diagnostics for InfiniBand Fabrics
 ----------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 DESCRIPTION
 ===========
diff --git a/doc/rst/perfquery.8.in.rst b/doc/rst/perfquery.8.in.rst
index 5e3d709..c09c3e1 100644
--- a/doc/rst/perfquery.8.in.rst
+++ b/doc/rst/perfquery.8.in.rst
@@ -1,15 +1,14 @@
 =========
-PERFQUERY
+perfquery
 =========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 -----------------------------------------------
 query InfiniBand port counters on a single port
 -----------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/saquery.8.in.rst b/doc/rst/saquery.8.in.rst
index 0551917..9647297 100644
--- a/doc/rst/saquery.8.in.rst
+++ b/doc/rst/saquery.8.in.rst
@@ -1,15 +1,14 @@
 =======
-SAQUERY
+saquery
 =======
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 -------------------------------------------------
 query InfiniBand subnet administration attributes
 -------------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/sminfo.8.in.rst b/doc/rst/sminfo.8.in.rst
index 500d1d0..4d715d7 100644
--- a/doc/rst/sminfo.8.in.rst
+++ b/doc/rst/sminfo.8.in.rst
@@ -1,15 +1,15 @@
 ======
-SMINFO
+sminfo
 ======
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ---------------------------------
 query InfiniBand SMInfo attribute
 ---------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
+
 SYNOPSIS
 ========
 
diff --git a/doc/rst/smpdump.8.in.rst b/doc/rst/smpdump.8.in.rst
index 38460de..118288f 100644
--- a/doc/rst/smpdump.8.in.rst
+++ b/doc/rst/smpdump.8.in.rst
@@ -1,15 +1,14 @@
 =======
-SMPDUMP
+smpdump
 =======
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 --------------------------------------------
 dump InfiniBand subnet management attributes
 --------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/smpquery.8.in.rst b/doc/rst/smpquery.8.in.rst
index aa9983c..8ca98ab 100644
--- a/doc/rst/smpquery.8.in.rst
+++ b/doc/rst/smpquery.8.in.rst
@@ -1,15 +1,14 @@
 ========
-SMPQUERY
+smpquery
 ========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ---------------------------------------------
 query InfiniBand subnet management attributes
 ---------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========
diff --git a/doc/rst/vendstat.8.in.rst b/doc/rst/vendstat.8.in.rst
index abb4e33..7b5e9e6 100644
--- a/doc/rst/vendstat.8.in.rst
+++ b/doc/rst/vendstat.8.in.rst
@@ -1,15 +1,14 @@
 ========
-VENDSTAT
+vendstat
 ========
 
-:Date: @BUILD_DATE@
-:Manual section: 8
-:Manual group: Open IB Diagnostics
-
 ------------------------------------------
 query InfiniBand vendor specific functions
 ------------------------------------------
 
+:Date: @BUILD_DATE@
+:Manual section: 8
+:Manual group: Open IB Diagnostics
 
 SYNOPSIS
 ========