Skip to content

Commit bcfbedc

Browse files
committed
docs/user-manual.txt: drop chapters with config-prereqs.txt and ci-farm-lxc-setup.txt, refer to qa-guide now (also from other docs) [networkupstools#2832]
Signed-off-by: Jim Klimov <[email protected]>
1 parent d2e5538 commit bcfbedc

5 files changed

+20
-32
lines changed

INSTALL.nut.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ tests>>" section details some more hints about such workflow, including some
205205
The NUT linkdoc:packager-guide[Packager Guide], which presents the best
206206
practices for installing and integrating NUT, is also a good reading.
207207

208-
The <<Config_Prereqs,Prerequisites for building NUT on different OSes>>
208+
The <<NUT_Config_Prereqs,Prerequisites for building NUT on different OSes>>
209209
document suggests prerequisite packages with tools and dependencies
210210
available and needed to build and test as much as possible of NUT on
211211
numerous platforms, written from perspective of CI testing (if you
@@ -463,7 +463,7 @@ ports involved, and to read the production configuration files).
463463
Pre-requisites
464464
^^^^^^^^^^^^^^
465465
466-
The <<Config_Prereqs,Prerequisites for building NUT on different OSes>>
466+
The <<NUT_Config_Prereqs,Prerequisites for building NUT on different OSes>>
467467
document details tools and dependencies that were added on NUT CI build
468468
environments, which now cover many operating systems. This should
469469
provide a decent starting point for the build on yours (PRs to update
@@ -857,7 +857,7 @@ and help would be welcome!
857857
It should currently be possible to build the codebase in native Windows
858858
with MSYS2/MinGW and cross-building from Linux with mingw (preferably
859859
in a Debian/Ubuntu container). Refer to
860-
link:config-prereqs.txt[Prerequisites for building NUT on different OSes]
860+
link:docs/config-prereqs.txt[Prerequisites for building NUT on different OSes]
861861
and link:scripts/Windows/README.adoc[scripts/Windows/README.adoc file]
862862
for respective build environment preparation instructions.
863863

docs/asciidoc.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
# base document name.
5555
# Example:
5656
# linkdoc:user-manual[user manual,NUT_Security]
57-
# linkdoc:user-manual[Prerequisites for building NUT on different OSes,Config_Prereqs,docs/config-prereqs.txt]
57+
# linkdoc:qa-manual[Prerequisites for building NUT on different OSes,NUT_Config_Prereqs,docs/config-prereqs.txt]
5858
# linkdoc:developer-guide[developer guide,_status_data]
5959
# linksingledoc:FAQ[shopping tips,_which_ups_should_i_buy]
6060

docs/ci-farm-lxc-setup.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ Also note the container/system naming without underscore in "x86_64" --
223223
https://wiki.archlinux.org/title/Install_Arch_Linux_from_existing_Linux#Using_pacman_from_the_host_system
224224
for details.
225225
On a Debian/Ubuntu host, assumed ready for NUT builds per
226-
linkdoc:user-manual[Prerequisites for building NUT on different OSes,Config_Prereqs,docs/config-prereqs.txt],
226+
linkdoc:qa-manual[Prerequisites for building NUT on different OSes,NUT_Config_Prereqs,docs/config-prereqs.txt],
227227
it would start like this:
228228
+
229229
------

docs/qa-guide.adoc

+12-4
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,15 @@ FIXME: Write the chapter text.
7070
Continuous Integration (NUT CI farm)
7171
------------------------------------
7272

73-
FIXME: Write the chapter intro text.
73+
[[CI_Farm_Notes]]
74+
CI Farm configuration notes
75+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
76+
77+
NOTE: This chapter contains information about NUT CI farm setup tricks
78+
that were applied at different times by the maintainer team to ensure
79+
regular builds and tests of the codebase. Whether these are used in
80+
daily production today or not, similar setup should be possible locally
81+
on developer and contributor machines.
7482

7583
Multiple FOSS CI providers and technologies
7684
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -126,9 +134,9 @@ include::ci-farm-lxc-setup.txt[]
126134

127135
:leveloffset: 0
128136

129-
[[Config_Prereqs]]
130-
NUT build prerequisites
131-
-----------------------
137+
[[NUT_Config_Prereqs]]
138+
Prerequisites for building NUT on different OSes
139+
------------------------------------------------
132140

133141
:leveloffset: 1
134142

docs/user-manual.txt

+3-23
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,9 @@ include::cables.txt[]
260260
Appendix H: Configure options
261261
=============================
262262

263-
NOTE: For more information about build environment setup, see chapters
264-
below about <<Config_Prereqs,Configuration prerequisites>>
265-
and <<CI_Farm_Notes,CI Farm configuration notes>>.
263+
NOTE: For more information about build environment setup, see chapters about
264+
linkdoc:qa-guide[Prerequisites for building NUT on different OSes,NUT_Config_Prereqs,docs/config-prereqs.txt]
265+
and linkdoc:qa-guide[Custom NUT CI farm build agents: LXC containers,CI_LXC,docs/ci-farm-lxc-setup.txt].
266266

267267
include::configure.txt[]
268268

@@ -279,23 +279,3 @@ Appendix J: Project history
279279
===========================
280280

281281
include::history.txt[]
282-
283-
284-
[[Config_Prereqs]]
285-
Appendix K: Prerequisites for building NUT on different OSes
286-
============================================================
287-
288-
include::config-prereqs.txt[]
289-
290-
291-
[[CI_Farm_Notes]]
292-
Appendix L: CI Farm configuration notes
293-
=======================================
294-
295-
NOTE: This chapter contains information about NUT CI farm setup tricks
296-
that were applied at different times by the maintainer team to ensure
297-
regular builds and tests of the codebase. Whether these are used in
298-
daily production today or not, similar setup should be possible locally
299-
on developer and contributor machines.
300-
301-
include::ci-farm-lxc-setup.txt[]

0 commit comments

Comments
 (0)