Skip to content

Commit db51203

Browse files
committed
docs/download.txt: revise notes on snapshots (not only GitHub now) and build types (git/dist) [#1400]
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
1 parent 1c97535 commit db51203

1 file changed

Lines changed: 21 additions & 18 deletions

File tree

docs/download.txt

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,13 @@ This section presents the different methods to download NUT.
1111
Building from source code
1212
-------------------------
1313

14-
You will need a number of tools such as `autoconf`, `automake` and `libtool`
15-
to use these checkouts or snapshots to generate the `configure` script and
16-
some other files. A more complete list for different platforms can be seen in
14+
To build from Git sources, you will need a number of tools such as `autoconf`,
15+
`automake` and `libtool` to use these checkouts or snapshots to generate the
16+
`configure` script and some other files. The distribution archives already
17+
include the `configure` script (as well as other files) and do not require
18+
auto* tools to prepare the sources for a build.
19+
20+
A more complete list of build prerequisites for different platforms can be seen in
1721
link:https://networkupstools.org/docs/qa-guide.chunked/_prerequisites_for_building_nut_on_different_oses.html[Prerequisites
1822
for building NUT on different OSes] chapter in the
1923
link:https://networkupstools.org/docs/qa-guide.chunked/[NUT QA Guide],
@@ -134,21 +138,20 @@ sources of operating system distributions, as listed below.
134138
Snapshots
135139
^^^^^^^^^
136140

137-
GitHub has several download links for repository snapshots (for particular
138-
tags or branches), but note that the ability to build NUT seamlessly from
139-
ZIP or `tar.gz` snapshots prepared by GitHub automatically (as a `git archive`
140-
of a checked-out workspace) is not regularly checked nor "supported" by the
141-
Network UPS Tools project. YMMV.
142-
143-
/////////
144-
TODO: #1400 to replace this with a NUT CI farm service to publish the tarballs
145-
146-
If our Buildbot instance is behaving, you can download a snapshot which does
147-
not require auto* tools from this
148-
link:http://buildbot.networkupstools.org/snapshots[builder]. Look for the
149-
latest *[tarball]* link towards the top of the page, and be sure to check the
150-
'Build ##' link to verify the branch name.
151-
/////////
141+
For pull requests and eventual merges into the master branch, a NUT CI job
142+
prepares correct "dist tarballs" with a snapshot of source code, as well as
143+
an archive with rendered documentation files (PDF, HTML, man pages).
144+
145+
Links to these "Dist and Docs" archives can be seen on GitHub in merge commit
146+
comments, and are posted as a rolling comment in pull requests. Keep in mind
147+
that artefacts like these are stored for up to 90 days, and can be rotated
148+
away earlier.
149+
150+
NOTE: GitHub has several download links for repository snapshots (made for
151+
particular tags or branches), but the ability to build NUT seamlessly from
152+
ZIP or `tar.gz` snapshots prepared by GitHub automatically (as a simple
153+
`git archive` of a checked-out workspace) is not regularly checked nor
154+
"supported" by the Network UPS Tools project. YMMV.
152155

153156
Older versions
154157
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)