Codebase list ibutils / 4af1a6c
Regenerate man pages from POD files Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com> Benjamin Drung 3 years ago
5 changed file(s) with 116 addition(s) and 48 deletion(s). Raw diff Collapse all Expand all
0 From e4b6018e5237bbfb545adee251e531f4a5ef2d45 Mon Sep 17 00:00:00 2001
1 From: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2 Date: Wed, 11 Nov 2020 11:56:40 +0100
3 Subject: Always update man pages if needed
4
5 Removing the man pages and not activating the automake maintainer mode
6 let the build fail:
7
8 ```
9 make[4]: Entering directory '/<<PKGBUILDDIR>>/ibis/doc'
10 ./ibis_pod2man ibis.1
11 Usage ./ibis_pod2man podFile [outFile]
12 Given podFile:ibis.1 extension != .pod
13 make[4]: *** [Makefile:568: ibis.1] Error 1
14 ```
15
16 So always update the man pages if needed.
17
18 Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
19 ---
20 ibdm/doc/Makefile.am | 2 +-
21 ibis/doc/Makefile.am | 2 +-
22 ibmgtsim/doc/Makefile.am | 2 +-
23 3 files changed, 3 insertions(+), 3 deletions(-)
24
25 diff --git a/ibdm/doc/Makefile.am b/ibdm/doc/Makefile.am
26 index bc28a03..e651510 100644
27 --- a/ibdm/doc/Makefile.am
28 +++ b/ibdm/doc/Makefile.am
29 @@ -46,7 +46,7 @@ EXTRA_DIST = \
30 ibtopodiff.pod ibtopodiff.1 \
31 ibdm_pod2man
32
33 -%.1: @MAINTAINER_MODE_TRUE@ %.pod
34 +%.1: %.pod
35 $(srcdir)/ibdm_pod2man $< $@
36 if test ! $@ -ef $(srcdir)/$@ ; then cp -f $@ $(srcdir)/$@; fi
37
38 diff --git a/ibis/doc/Makefile.am b/ibis/doc/Makefile.am
39 index 5509865..24dc392 100644
40 --- a/ibis/doc/Makefile.am
41 +++ b/ibis/doc/Makefile.am
42 @@ -34,6 +34,6 @@ man_MANS = ibis.1
43
44 EXTRA_DIST = ibis.pod ibis.1
45
46 -%.1: @MAINTAINER_MODE_TRUE@ %.pod
47 +%.1: %.pod
48 $(srcdir)/ibis_pod2man $< $@
49 if test ! $@ -ef $(srcdir)/$@ ; then cp -f $@ $(srcdir)/$@; fi
50 diff --git a/ibmgtsim/doc/Makefile.am b/ibmgtsim/doc/Makefile.am
51 index a9c0237..b7a6969 100644
52 --- a/ibmgtsim/doc/Makefile.am
53 +++ b/ibmgtsim/doc/Makefile.am
54 @@ -37,6 +37,6 @@ EXTRA_DIST = \
55 IBMgtSim.pod RunSimTest.pod ibmsquit.pod mkSimNodeDir.pod ibmssh.pod \
56 ibmgtsim_pod2man
57
58 -%.1: @MAINTAINER_MODE_TRUE@ %.pod
59 +%.1: %.pod
60 $(srcdir)/ibmgtsim_pod2man $< $@
61 if test ! $@ -ef $(srcdir)/$@ ; then cp -f $@ $(srcdir)/$@; fi
62 --
63 2.25.1
64
0 From 59f28cd388c156b2eb450d0195d7a7a6570caa9e Mon Sep 17 00:00:00 2001
1 From: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2 Date: Wed, 11 Nov 2020 12:33:29 +0100
3 Subject: Fix generating man pages in place
4
5 Building the man pages fail in place:
6
7 ```
8 make[4]: Entering directory '/<<PKGBUILDDIR>>/ibis/doc'
9 ./ibis_pod2man ibis.pod ibis.1
10 cp -f ibis.1 ./ibis.1
11 cp: 'ibis.1' and './ibis.1' are the same file
12 make[4]: *** [Makefile:569: ibis.1] Error 1
13 ```
14
15 Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
16 ---
17 ibis/doc/Makefile.am | 2 +-
18 ibmgtsim/doc/Makefile.am | 2 +-
19 2 files changed, 2 insertions(+), 2 deletions(-)
20
21 diff --git a/ibis/doc/Makefile.am b/ibis/doc/Makefile.am
22 index 9f75692..5509865 100644
23 --- a/ibis/doc/Makefile.am
24 +++ b/ibis/doc/Makefile.am
25 @@ -36,4 +36,4 @@ EXTRA_DIST = ibis.pod ibis.1
26
27 %.1: @MAINTAINER_MODE_TRUE@ %.pod
28 $(srcdir)/ibis_pod2man $< $@
29 - cp -f $@ $(srcdir)/$@
30 + if test ! $@ -ef $(srcdir)/$@ ; then cp -f $@ $(srcdir)/$@; fi
31 diff --git a/ibmgtsim/doc/Makefile.am b/ibmgtsim/doc/Makefile.am
32 index 24b411c..a9c0237 100644
33 --- a/ibmgtsim/doc/Makefile.am
34 +++ b/ibmgtsim/doc/Makefile.am
35 @@ -39,4 +39,4 @@ EXTRA_DIST = \
36
37 %.1: @MAINTAINER_MODE_TRUE@ %.pod
38 $(srcdir)/ibmgtsim_pod2man $< $@
39 - cp -f $@ $(srcdir)/$@
40 + if test ! $@ -ef $(srcdir)/$@ ; then cp -f $@ $(srcdir)/$@; fi
41 --
42 2.25.1
43
99 ibdiag/doc/ibdiagpath.pod | 3 ++-
1010 ibdiag/src/ibdebug_if.tcl | 2 +-
1111 ibdiag/src/ibdiagui.tcl | 2 +-
12 ibdm/doc/ibdmchk.1 | 8 ++++----
1312 ibdm/doc/ibdmchk.pod | 8 ++++----
1413 ibdm/ibdm/LinkCover.cpp | 6 +++---
1514 ibdm/ibdm/SubnMgt.cpp | 8 ++++----
1918 ibis/src/ibis_wrap.c | 2 +-
2019 ibis/src/ibissh_wrap.cpp | 2 +-
2120 ibis/tests/ibcr_test.tcl | 2 +-
22 ibmgtsim/doc/IBMgtSim.1 | 2 +-
2321 ibmgtsim/doc/IBMgtSim.pod | 2 +-
2422 ibmgtsim/src/client.cpp | 2 +-
2523 ibmgtsim/src/sim.cpp | 4 ++--
2826 ibmgtsim/tests/init.test.tcl | 8 ++++----
2927 ibmgtsim/utils/IBMgtSim | 4 ++--
3028 ibmgtsim/utils/RunSimTest | 2 +-
31 26 files changed, 62 insertions(+), 61 deletions(-)
29 24 files changed, 57 insertions(+), 56 deletions(-)
3230
3331 diff --git a/ibdiag/demo/sm-single-master.tcl b/ibdiag/demo/sm-single-master.tcl
3432 index 5b414c8..3dd5c65 100644
145143 set r ""
146144 LogAppend "-I-Invoking ibdiagnet ...."
147145 # puts "-I- Invoking ibdiagnet ...."
148 diff --git a/ibdm/doc/ibdmchk.1 b/ibdm/doc/ibdmchk.1
149 index 7537473..b725702 100644
150 --- a/ibdm/doc/ibdmchk.1
151 +++ b/ibdm/doc/ibdmchk.1
152 @@ -186,7 +186,7 @@ Use enhanced routing algorithm when \s-1LMC\s0 > 0 and report the resulting path
153 .IX Item "-r|--roots <roots file> A file with all the roots node names (one on each line)."
154 .SH "VERIFICATION MODE DESCRIPTION"
155 .IX Header "VERIFICATION MODE DESCRIPTION"
156 -After the cluster is built and OpenSM is run (using flag \-D 0x43) it reports the subnet and \s-1FDB\s0 tables into the files osm\-subnet.lst, osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /tmp in older OpenSM versions). ibdiagnet is also producing the same files in its output directory.
157 +After the cluster is built and OpenSM is run (using flag \-D 0x43) it reports the subnet and \s-1FDB\s0 tables into the files osm\-subnet.lst, osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /var/cache/ibutils in older OpenSM versions). ibdiagnet is also producing the same files in its output directory.
158 Based on these files the utility checks all \s-1CA\s0 to \s-1CA\s0 connectivity. Further analysis for credit deadlock potential is performed and reported.
159 In case of an \s-1LMC\s0 > 0 it reports histograms for how many systems and nodes are common between the different paths for the same port pairs.
160 .SH "ARGUMENTS"
161 @@ -208,15 +208,15 @@ Provides this help message
162 .RE
163 .IP "\-s|\-\-subnet <file>"
164 .IX Item "-s|--subnet <file>"
165 -OpenSM subnet.lst file (default is /var/log/osm\-subnet.lst or /tmp/subnet.lst)
166 +OpenSM subnet.lst file (default is /var/log/osm\-subnet.lst or /var/cache/ibutils/subnet.lst)
167 .RE
168 .IP "\-f|\-\-fdb <file>"
169 .IX Item "-f|--fdb <file>"
170 -OpenSM dump of Ucast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.fdbs or /tmp/osm.fdbs).
171 +OpenSM dump of Ucast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.fdbs or /var/cache/ibutils/osm.fdbs).
172 .RE
173 .IP "\-m|\-\-mcfdb <file>"
174 .IX Item "-m|--mcfdb <file>"
175 -OpenSM dump of Multicast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.mcfdbs or /tmp/osm.mcfdbs).
176 +OpenSM dump of Multicast \s-1LFDB\s0. Use \-D 0x41 to generate it (default is /var/log/osm.mcfdbs or /var/cache/ibutils/osm.mcfdbs).
177 .RE
178 .IP "\-c|\-\-psl <file>"
179 .IX Item "-c|--psl <file>"
180146 diff --git a/ibdm/doc/ibdmchk.pod b/ibdm/doc/ibdmchk.pod
181147 index dabfafa..ed85818 100644
182148 --- a/ibdm/doc/ibdmchk.pod
429395 ibis_init
430396
431397 set availPorts [ibis_get_local_ports_info]
432 diff --git a/ibmgtsim/doc/IBMgtSim.1 b/ibmgtsim/doc/IBMgtSim.1
433 index e8ac646..626b956 100644
434 --- a/ibmgtsim/doc/IBMgtSim.1
435 +++ b/ibmgtsim/doc/IBMgtSim.1
436 @@ -158,7 +158,7 @@ A tcl file to be sourced after the fabric is setup.
437 .RE
438 .IP "\-l log-file"
439 .IX Item "-l log-file"
440 -Set the log file of the simulator (default is /tmp/ibsim.log)
441 +Set the log file of the simulator (default is /var/cache/ibutils/ibsim.log)
442 .RE
443 .IP "\-p server-port"
444 .IX Item "-p server-port"
445398 diff --git a/ibmgtsim/doc/IBMgtSim.pod b/ibmgtsim/doc/IBMgtSim.pod
446399 index f9b422f..ee3e2a8 100644
447400 --- a/ibmgtsim/doc/IBMgtSim.pod
44 makefile_dependencies.patch
55 cross.patch
66 gcc-10.patch
7 Fix-generating-man-pages-in-place.patch
8 Always-update-man-pages-if-needed.patch
1515 override_dh_auto_install:
1616 dh_auto_install
1717 chmod ogu-x debian/tmp/usr/lib/$(DEB_HOST_MULTIARCH)/ibdm1.5.7/ibnl/*.ibnl
18
19 override_dh_auto_clean:
20 dh_auto_clean
21 rm -f $(shell find -name '*.pod' | sed 's/\.pod/.1/')