Skip to content

Commit 5d3ff46

Browse files
committed
docs/config-prereqs.txt, docs/nut.dict: wrap most long lines, reword a few
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
1 parent c7debac commit 5d3ff46

File tree

2 files changed

+63
-30
lines changed

2 files changed

+63
-30
lines changed

docs/config-prereqs.txt

Lines changed: 60 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,8 @@ metadata about recently published package revisions:
210210
:; apt-get install \
211211
aspell aspell-en
212212

213-
# For other doc types (man-page, PDF, HTML) generation - massive packages (TEX, X11):
213+
# For other doc types (man-page, PDF, HTML) generation - massive packages
214+
# (TEX, X11):
214215
:; apt-get install \
215216
asciidoc source-highlight python3-pygments dblatex
216217

@@ -317,7 +318,8 @@ file (as the aged distributions become less served by mirrors), such as:
317318
+
318319
------
319320
# e.g. for CentOS7 currently:
320-
:; yum install https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-7-14.noarch.rpm
321+
:; yum install \
322+
https://download-ib01.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-7-14.noarch.rpm
321323

322324
# And edit /etc/yum.repos.d/epel.repo to uncomment and set the baseurl=...
323325
# lines, and comment away the mirrorlist= lines (if yum hiccups otherwise)
@@ -336,7 +338,8 @@ detailing how to replace `/etc/yum.repos.d/` contents (you can wholesale rename
336338
the existing directory and populate a new one with `curl` downloads from the
337339
article), and additional key trust for EPEL packages:
338340
------
339-
:; yum install https://dl.fedoraproject.org/pub/archive/epel/6/x86_64/epel-release-6-8.noarch.rpm
341+
:; yum install \
342+
https://dl.fedoraproject.org/pub/archive/epel/6/x86_64/epel-release-6-8.noarch.rpm
340343
------
341344

342345
Set up CentOS packages for NUT
@@ -413,7 +416,8 @@ drivers in distro packaging of NUT. Resolution and doc PRs are welcome.
413416
:; yum install \
414417
aspell aspell-en
415418

416-
# For other doc types (man-page, PDF, HTML) generation - massive packages (TEX, X11):
419+
# For other doc types (man-page, PDF, HTML) generation - massive packages
420+
# (TEX, X11):
417421
:; yum install \
418422
asciidoc source-highlight python-pygments dblatex
419423

@@ -441,8 +445,10 @@ drivers in distro packaging of NUT. Resolution and doc PRs are welcome.
441445
neon-devel
442446
#?# is python-augeas needed? exists at least...
443447
#?# no (lib)i2c-devel ...
444-
#?# no (lib)ipmimonitoring-devel ... would "freeipmi-ipmidetectd" cut it at least for run-time?
445-
#?# no (lib)gpio(d)-devel - starts with CentOS 8 (or extra repositories for later minor releases of CentOS 7)
448+
#?# no (lib)ipmimonitoring-devel ... would "freeipmi-ipmidetectd"
449+
#?# cut it at least for run-time?
450+
#?# no (lib)gpio(d)-devel - starts with CentOS 8 (or extra repositories
451+
#?# for later minor releases of CentOS 7)
446452

447453
# Some NUT code related to lua may be currently limited to lua-5.1
448454
# or possibly 5.2; the former is default in CentOS 7 releases...
@@ -642,7 +648,14 @@ For procedures below, this is automated via `root` profile to become a
642648
`slackpkg-install` command:
643649
----
644650
:; grep "slackpkg-install" ~/.profile || {
645-
echo 'slackpkg-install() { for P in "$@" ; do echo "=== $P:"; slackpkg info "$P" || slackpkg install "$P" || break ; done; }' >> ~/.profile
651+
cat >> ~/.profile << 'EOF'
652+
slackpkg-install() {
653+
for P in "$@" ; do
654+
echo "=== $P:"
655+
slackpkg info "$P" || slackpkg install "$P" || break
656+
done
657+
}
658+
EOF
646659
}
647660
:; . ~/.profile
648661
----
@@ -737,7 +750,8 @@ like this:
737750
:; wget -m -l1 http://www.slackware.com/~alien/slackbuilds/asciidoc/pkg/ && \
738751
find . -name '*.t?z'
739752

740-
:; installpkg ./www.slackware.com/~alien/slackbuilds/asciidoc/pkg/asciidoc-8.1.0-noarch-2.tgz
753+
:; (cd ./www.slackware.com/~alien/slackbuilds/asciidoc/pkg/ && \
754+
installpkgasciidoc-8.1.0-noarch-2.tgz )
741755
----
742756

743757
Note that some packages are further separated by Slackware version, e.g. with
@@ -819,7 +833,8 @@ below.
819833
:; pkg install \
820834
aspell en-aspell
821835

822-
# For other doc types (man-page, PDF, HTML) generation - massive packages (TEX, X11):
836+
# For other doc types (man-page, PDF, HTML) generation - massive packages
837+
# (TEX, X11):
823838
:; pkg install \
824839
asciidoc source-highlight textproc/py-pygments dblatex
825840

@@ -963,7 +978,8 @@ default site.
963978
:; pkg_add \
964979
aspell
965980

966-
# For other doc types (man-page, PDF, HTML) generation - massive packages (TEX, X11):
981+
# For other doc types (man-page, PDF, HTML) generation - massive packages
982+
# (TEX, X11):
967983
:; pkg_add \
968984
asciidoc source-highlight py-pygments dblatex \
969985
docbook2x docbook-to-man
@@ -985,7 +1001,8 @@ default site.
9851001
# to only deliver a numbered SO library name), e.g.:
9861002
:; pkg_add neon && \
9871003
if ! test -s /usr/local/lib/libneon.so ; then
988-
ln -s "`cd /usr/local/lib && ls -1 libneon.so.* | sort -n | tail -1`" /usr/local/lib/libneon.so
1004+
ln -s "`cd /usr/local/lib && ls -1 libneon.so.* | sort -n | tail -1`" \
1005+
/usr/local/lib/libneon.so
9891006
fi
9901007

9911008
# Select a LUA-5.1 (or possibly 5.2?) version
@@ -1009,11 +1026,15 @@ Recommended:
10091026
done ; \
10101027
)
10111028

1012-
:; ( cd /usr/bin && for T in gcc g++ cpp ; do ln -s "$T" "$T-4.2.1" ; done )
1013-
:; ( cd /usr/lib/ccache && for T in gcc g++ cpp ; do ln -s "$T" "$T-4.2.1" ; done )
1029+
:; ( cd /usr/bin && for T in gcc g++ cpp ; \
1030+
do ln -s "$T" "$T-4.2.1" ; done )
1031+
:; ( cd /usr/lib/ccache && for T in gcc g++ cpp ; \
1032+
do ln -s "$T" "$T-4.2.1" ; done )
10141033

1015-
:; ( cd /usr/bin && for T in clang clang++ clang-cpp ; do ln -s "$T" "$T-7.0.1" ; done )
1016-
:; ( cd /usr/lib/ccache && for T in clang clang++ clang-cpp ; do ln -s "$T" "$T-7.0.1" ; done )
1034+
:; ( cd /usr/bin && for T in clang clang++ clang-cpp ; \
1035+
do ln -s "$T" "$T-7.0.1" ; done )
1036+
:; ( cd /usr/lib/ccache && for T in clang clang++ clang-cpp ; \
1037+
do ln -s "$T" "$T-7.0.1" ; done )
10171038
------
10181039

10191040
For compatibility with common setups on other operating systems, can add
@@ -1058,7 +1079,8 @@ Note that `PATH` for builds on NetBSD should include `local` and
10581079
`pkg`; the default after installation of the test system was:
10591080

10601081
------
1061-
:; PATH="/sbin:/usr/sbin:/bin:/usr/bin:/usr/pkg/sbin:/usr/pkg/bin:/usr/X11R7/bin:/usr/local/sbin:/usr/local/bin"
1082+
:; PATH="/sbin:/usr/sbin:/bin:/usr/bin:/usr/pkg/sbin:/usr/pkg/bin"
1083+
:; PATH="$PATH:/usr/X11R7/bin:/usr/local/sbin:/usr/local/bin"
10621084
:; export PATH
10631085
------
10641086

@@ -1088,7 +1110,8 @@ this document describes, but if an e.g. older release lacks it, it can be added
10881110
using the older tooling:
10891111

10901112
----
1091-
:; PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/NetBSD/$(uname -p)/$(uname -r|cut -f '1 2' -d.)/All/"
1113+
:; CDN="http://cdn.NetBSD.org/pub/pkgsrc/packages/NetBSD"
1114+
:; PKG_PATH="${CDN}/$(uname -p)/$(uname -r|cut -f '1 2' -d.)/All/"
10921115
:; export PKG_PATH
10931116
:; pkg_add pkgin
10941117
----
@@ -1277,10 +1300,12 @@ Typical tooling would include:
12771300
:; pkg install \
12781301
aspell text/aspell/en
12791302

1280-
# For other doc types (man-page, PDF, HTML) generation - massive packages (TEX, X11):
1303+
# For other doc types (man-page, PDF, HTML) generation - massive packages
1304+
# (TEX, X11):
12811305
:; pkg install \
12821306
asciidoc libxslt \
1283-
docbook/dtds docbook/dsssl docbook/xsl docbook docbook/sgml-common pygments-39 \
1307+
docbook/dtds docbook/dsssl docbook/xsl docbook docbook/sgml-common \
1308+
pygments-39 \
12841309
image/graphviz expect graphviz-tcl
12851310

12861311
# For CGI graph generation - massive packages (X11):
@@ -1290,7 +1315,8 @@ Typical tooling would include:
12901315
:; pkg install \
12911316
openssl library/mozilla-nss \
12921317
library/augeas python/augeas \
1293-
libusb-1 libusbugen system/library/usb/libusb system/header/header-usb driver/usb/ugen \
1318+
libusb-1 libusbugen system/library/usb/libusb \
1319+
system/header/header-usb driver/usb/ugen \
12941320
libmodbus \
12951321
library/neon \
12961322
system/management/snmp/net-snmp \
@@ -1414,10 +1440,11 @@ site for setup details.
14141440
:; pkg install sudo bash application/mc wget rsync pigz pbzip2 p7zip top
14151441

14161442
# NOTE: not all compiler versions may be served by all releases (e.g. OmniOS
1417-
# did not deliver clang in Core nor Extra repos for quite a while), some are
1418-
# obsoleted over time. While OmniOS LTS 151046 offers a range of clang 13 to
1419-
# 17, current stable (151052) includes also 18 and 19. Unlike OpenIndiana,
1420-
# OmniOS does not provide implicit (not-numbered) packages for clang or gcc.
1443+
# did not deliver clang in Core nor Extra repositories for quite a while),
1444+
# and some are obsoleted over time. While OmniOS 151036 lacked any clang,
1445+
# LTS 151046 offered a range of clang 13 to 17, and current stable (151052)
1446+
# includes also 18 and 19. Unlike OpenIndiana, OmniOS does not provide
1447+
# implicit default (not-numbered) packages for neither clang nor gcc.
14211448
# Check your distro repository offers with:
14221449
:; pkg info -r '*clang*' '*gcc*'
14231450
:; pkg search -r '*bin/g++*'
@@ -1598,12 +1625,14 @@ Overall, the successful test build using the NUT standard CI helper script
15981625
`ci_build.sh` had the following shell session settings:
15991626

16001627
----
1601-
### Common pre-sets from .profile or .bashrc:
1628+
### Common pre-sets from .profile or .bashrc (long lines wrapped for readability):
16021629
### bash-2.03$ echo $PATH
1603-
### /usr/bin:/usr/dt/bin:/usr/openwin/bin:/bin:/usr/ucb:/usr/tgcware/bin:/usr/tgcware/gnu:/usr/tgcware/gcc42/bin:/usr/tgcware/i386-pc-solaris2.8/bin
1630+
### /usr/bin:/usr/dt/bin:/usr/openwin/bin:/bin:/usr/ucb:/usr/tgcware/bin:\
1631+
### /usr/tgcware/gnu:/usr/tgcware/gcc42/bin:/usr/tgcware/i386-pc-solaris2.8/bin
16041632

16051633
### bash-2.03$ echo $LD_LIBRARY_PATH
1606-
### /usr/lib:/usr/tgcware/lib:/usr/tgcware/gcc42/lib:/usr/tgcware/i386-pc-solaris2.8/lib
1634+
### /usr/lib:/usr/tgcware/lib:/usr/tgcware/gcc42/lib:\
1635+
### /usr/tgcware/i386-pc-solaris2.8/lib
16071636

16081637
### Further tuning for the build itself:
16091638
:; git clean -fffdddxxx
@@ -1852,7 +1881,8 @@ export PATH
18521881

18531882
# Alternately there is libusb-compat (libusb-1.0 codebase exposing the older
18541883
# libusb-0.1 API) which SHOULD NOT be installed along with the real libusb-0.1:
1855-
# :; pacman -S --needed mingw-w64-x86_64-libusb-compat-git mingw-w64-clang-x86_64-libusb-compat-git
1884+
# :; pacman -S --needed mingw-w64-x86_64-libusb-compat-git \
1885+
# mingw-w64-clang-x86_64-libusb-compat-git
18561886

18571887
# This also pulls *-devel of several other projects:
18581888
:; pacman -S --needed \
@@ -1877,7 +1907,8 @@ and lack a set for `clang` tools; easy-peasy fix with:
18771907

18781908
----
18791909
:; cd /mingw64/lib/ccache/bin
1880-
:; for T in clang clang++ clang-cpp ; do sed "s/gcc/$T/" < gcc > "$T" ; chmod +x "$T" ; done
1910+
:; for T in clang clang++ clang-cpp ; do \
1911+
sed "s/gcc/$T/" < gcc > "$T" ; chmod +x "$T" ; done
18811912
----
18821913

18831914
Note that default `ccache` seems quirky on Windows MSYS2, possibly due to

docs/nut.dict

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
personal_ws-1.1 en 3455 utf-8
1+
personal_ws-1.1 en 3457 utf-8
22
AAC
33
AAS
44
ABI
@@ -152,6 +152,7 @@ CBI
152152
CCC
153153
CCCC
154154
CDC
155+
CDN
155156
CDS
156157
CELLPADDING
157158
CELLSPACING
@@ -2674,6 +2675,7 @@ openmp
26742675
openpimi
26752676
openssh
26762677
openssl
2678+
openwin
26772679
oper
26782680
optimizations
26792681
optiups

0 commit comments

Comments
 (0)