Fix make docs for runs made completely out-of-tree#2318
Merged
jimklimov merged 58 commits intonetworkupstools:masterfrom Feb 22, 2024
Merged
Fix make docs for runs made completely out-of-tree#2318jimklimov merged 58 commits intonetworkupstools:masterfrom
make docs for runs made completely out-of-tree#2318jimklimov merged 58 commits intonetworkupstools:masterfrom
Conversation
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…irect to stdout Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…up if we "failed to generate the ChangeLog" to produce a sane adoc=>pdf note anyway Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…repo is) and use CHANGELOG_FILE to store the result in BUILD dir Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…m git Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…arget for building out-of-tree Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…" separately from actually "Generating" Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…e calling (possibly parallel) sub-make for docs or docs/man Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…" to invoke jobserver Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…cdir to avoid the mess with relative paths and ".." offsets Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
added
documentation
CI
|
❌ Build nut 2.8.1.1442-master failed (commit eec3d561b1 by @jimklimov) |
…gets on .prep-src-docs Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…d for in-tree builds too Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…,tool}-names.txt recipes Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
|
❌ Build nut 2.8.1.1444-master failed (commit f9eb6b8311 by @jimklimov) |
…s first Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…ep-src-docs, avoid sub-makes where we can Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
force-pushed
the
fix-make-docs-out-of-tree
branch
from
b6115ea to
82458d5
Compare
|
❌ Build nut 2.8.1.1446-master failed (commit 730466c2ca by @jimklimov) |
…to PREP_SRC Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…ks, be sure to only hit symlinks Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…ks, report current workdir (help with relative src/build dirs) Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…r PREP_SRC symlinks Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
force-pushed
the
fix-make-docs-out-of-tree
branch
from
86ca263 to
56bc09a
Compare
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…epped" suffix (with a dash) Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…lean Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
|
❌ Build nut 2.8.1.1477-master failed (commit 06833309aa by @jimklimov) |
...it upsets some versions of `dblatex` (used in PDF generation) which treat everything after the *first* dot as a file extension. Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
force-pushed
the
fix-make-docs-out-of-tree
branch
2 times, most recently
from
9d18242 to
3713563
Compare
|
✅ Build nut 2.8.1.1479-master completed (commit 7d25e4b31f by @jimklimov) |
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…-docs are pre-generated Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
TOTHINK: Do we want to just automate this discovery? Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
… caller into docs/Makefile parsing Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…verywhere we call another $(MAKE) Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
jimklimov
force-pushed
the
fix-make-docs-out-of-tree
branch
from
3713563 to
1312b5f
Compare
jimklimov
added
the
refactor/fightwarn
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
This was referenced Feb 27, 2024
ntd
added a commit
to ntd/nut
that referenced
this pull request
May 21, 2024
Signed-off-by: Nicola Fontana <ntd@entidi.it>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix issues like:
ChangeLog.html/.pdf(due to building not in a git workspace, and the placeholder text being not a valid asciidoc chapter, andasciidoc(texts, configs) when building not in the directory where the sources are (and the source directory may be read-only), especially when we juggle included files (linkman-doc*) or configs (docinfo.xml) generated for the build and referenced from git-tracked original texts.This seemed to work for
make distcheckwith relative paths, but fared worse when the build tree was in a completely separate location and absolute paths got involved, at least with some "make" implementations.A side effect is that we
make .prep-src-docs(to make an horde of symlinks if building out-of-tree) in advance normally, since we would otherwise have to spell out all the dependencies (this text includes that text and those images) and conjure up.suf1.suf2sort of rules, including for a few files without a simple suffix liketxt... wholesale ops proved easier (but took a while to get them working everywhere).In the end, this also revisits all places we call another
$(MAKE)instance to do something, to ensure the "make" markup includes the+prefix (for job server integration) and that$(AM_MAKEFLAGS)are passed down consistently.