branch='trunk'
if ! command -v git >/dev/null 2>&1; then
echo 'byggsteg: git is not on this deployment PATH, so the clone cannot be updated' >&2
exit 1
fi
if ! cd "$dir"; then
echo "byggsteg: cannot enter the clone $dir" >&2
exit 1
fi
root=$(git rev-parse --show-toplevel 2>/dev/null)
if [ "$root" != "$(pwd -P)" ]; then
echo "byggsteg: $dir is not a git checkout; remove it and the next run clones it again" >&2
exit 1
fi
if ! origin=$(git remote get-url origin 2>/dev/null); then
echo "byggsteg: $dir has no origin remote to fetch $branch from" >&2
exit 1
fi
before=$(git rev-parse --short HEAD 2>/dev/null) || before=none
attempt=1
while :; do
if GIT_TERMINAL_PROMPT=0 git fetch --quiet origin "+refs/heads/$branch:refs/remotes/origin/$branch"; then
break
fi
if [ "$attempt" -ge 3 ]; then
echo "byggsteg: could not fetch $branch from $origin after 3 attempts; is the branch still there, and is the remote reachable?" >&2
exit 1
fi
echo "byggsteg: fetching $branch from $origin failed; retrying in $((attempt * 2))s" >&2
sleep $((attempt * 2))
attempt=$((attempt + 1))
done
if ! git checkout --quiet --force -B "$branch" FETCH_HEAD; then
echo "byggsteg: fetched $branch from $origin but could not check it out" >&2
exit 1
fi
after=$(git rev-parse --short HEAD)
if [ "$before" = "$after" ]; then
echo "byggsteg: $branch was already at $after"
else
echo "byggsteg: $branch moved from $before to $after"
fi
byggsteg: trunk moved from 3505979 to 85ffcd1
setupuname -a✓ succeeded1 lines · 0.0s
Linux wolk-jjba 7.2.11-gnu #1 SMP PREEMPT_DYNAMIC 1 x86_64 GNU/Linux
commit 85ffcd1392a86e2f76d27b147657029177b6b6f3
Author: Josep Bigorra <jjbigorra@gmail.com>
Date: Tue Nov 17 15:46:26 2026 +0100
chore(release): v0.6.2, document every definition
Regenerates the API reference from the new docstrings, taken from the diff
docs-check reported.
M CHANGELOG.org
M README.org
M manual/api/index.texi
M manual/main.texi
M src/dokgen/cli.scm
M website/index.html
runmaak version-check✓ succeeded8 lines · 0.1s
--------------------------------------------------------------
Maak 0.14.0: the infinitely extensible command runner
Loading tasks from Maak file: /etc/byggsteg/job-clone/guile-dokgen/trunk/maak.scm
Executing Maak tasks: version-check
--------------------------------------------------------------
=> Running Maak task: version-check
Fail when a file quotes a version other than the one the source states.
version 0.6.2 is consistent in 4 files
testmaak check✓ succeeded31 lines · 6.0s
channels.scm:17:6: warning: channel 'jointhefreeworld' is not trusted
wrote `/tmp/tmp.ycLvl0KWFT'
wrote `/tmp/tmp.WxTYgVZWXF'
wrote `/tmp/tmp.LxVtAMY1jL'
wrote `/tmp/tmp.4BC7hF8eT5'
wrote `/tmp/tmp.pTVmsWWI5G'
wrote `/tmp/tmp.OW4ddmBh6S'
wrote `/tmp/tmp.YTep3yRgze'
wrote `/tmp/tmp.AVUcfpiout'
wrote `/tmp/tmp.NBdD0zK2LQ'
wrote `/tmp/tmp.ieGFx4bSIq'
wrote `/tmp/tmp.nWxDmRoIFh'
wrote `/tmp/tmp.9JoP3lOzBM'
wrote `/tmp/tmp.VMGEr87h2h'
wrote `/tmp/tmp.m6LZOiIMso'
WARNING: Use of `load' in declarative module (#{ g111}#). Add #:declarative? #f to your define-module invocation.
wrote `/tmp/tmp.Hf7aFpVBtQ'
--------------------------------------------------------------
Maak 0.14.0: the infinitely extensible command runner
Loading tasks from Maak file: /etc/byggsteg/job-clone/guile-dokgen/trunk/maak.scm
Executing Maak tasks: check
--------------------------------------------------------------
=> Running Maak task: check
Compile every source and test module, so a syntax error fails the build.
Each file is compiled on its own, which is what makes one broken file name
itself rather than a pile of them.
Execute command:
guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh -c 'set -eu
find src tests etc -name '\''*.scm'\'' -print0 | xargs -0 -n 1 sh -c '\''guild compile -L ./src -L . -o "$(mktemp)" "$1"'\'' sh'
Executing: guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh -c 'set -eu
find src tests etc -name '\''*.scm'\'' -print0 | xargs -0 -n 1 sh -c '\''guild compile -L ./src -L . -o "$(mktemp)" "$1"'\'' sh'
testmaak test✓ succeeded113 lines · 0.7s
channels.scm:17:6: warning: channel 'jointhefreeworld' is not trusted
*** Entering test group: (dokgen data) ***
*** Entering test group: [procedure] file-path->module-name ***
* PASS: Convert Scheme file path to module name (multi-module library).
* PASS: Convert Scheme file path to module name (single-module library).
*** Leaving test group: [procedure] file-path->module-name ***
*** Entering test group: [procedure] group-api-objects ***
* PASS: A «parameters» group exists when the API exports parameters.
* PASS: All parameters exported by the API are included in their group.
* PASS: All objects in the «parameters» group are actually parameters.
* PASS: Raise &residual-export-exception when unbound export is found.
*** Leaving test group: [procedure] group-api-objects ***
*** Leaving test group: (dokgen data) ***
*** Test suite finished. ***
*** # of expected passes : 6
*** Entering test group: (dokgen templates) ***
*** Entering test group: [procedure] api-binding ***
* PASS: Render a binding that holds a record type.
* PASS: Render a binding that holds a record.
* PASS: Render a parameterless procedure.
* PASS: Render a procedure containing @verbatim examples.
* PASS: Render undocumented procedure.
* PASS: Render a documented macro.
* PASS: Render an undocumented macro.
* PASS: Render a parameter.
*** Leaving test group: [procedure] api-binding ***
*** Entering test group: [procedure] module-description ***
* PASS: Render standard module commentary.
* PASS: Render block-commented module commentary.
*** Leaving test group: [procedure] module-description ***
*** Entering test group: [procedure] procedure-parameters ***
* PASS: Render empty parameters.
* XPASS: Render required parameters.
source-file: tests/test-templates-stexi.scm
source-line: 269
source-form: (test-equal
"Render required parameters."
"param1 param2 param3"
(stexi:procedure-parameters required-params))
expected-value: param1 param2 param3
expected-error: #f
actual-value: param1 param2 param3
actual-error: #f
* XPASS: Render optional parameters.
source-file: tests/test-templates-stexi.scm
source-line: 280
source-form: (test-equal
"Render optional parameters."
"OPT: opt1 opt2"
(stexi:procedure-parameters optional-params))
expected-value: OPT: opt1 opt2
expected-error: #f
actual-value: OPT: opt1 opt2
actual-error: #f
* PASS: Render keyword parameters.
* PASS: Render note when arbitrary keyword parameters are allowed.
* PASS: Render args parameter.
*** Leaving test group: [procedure] procedure-parameters ***
*** Leaving test group: (dokgen templates) ***
*** Test suite finished. ***
*** # of expected passes : 14
*** # of unexpected passes : 2
*** Entering test group: (dokgen utils) ***
*** Entering test group: [procedure] min-indent ***
* PASS: Find the shorter number of spaces used for indentation.
* PASS: The indentation of an empty string is zero.
* PASS: The indentation of a single-line string is zero.
*** Leaving test group: [procedure] min-indent ***
*** Entering test group: [procedure] tabs->spaces ***
* PASS: Replace tabs with default number of spaces.
* PASS: Replace tabs with custom number of spaces.
*** Leaving test group: [procedure] tabs->spaces ***
*** Entering test group: [procedure] trim ***
* PASS: Trim off N spaces.
* PASS: Trim off more than N spaces.
*** Leaving test group: [procedure] trim ***
*** Entering test group: [procedure] unindent ***
* PASS: Remove unwanted tab indentation.
* PASS: Remove unwanted space indentation.
* PASS: Leave desired tab indentation.
* PASS: Handle empty docstring.
* PASS: Handle one-line docstring.
*** Leaving test group: [procedure] unindent ***
*** Leaving test group: (dokgen utils) ***
*** Test suite finished. ***
*** # of expected passes : 12
--------------------------------------------------------------
Maak 0.14.0: the infinitely extensible command runner
Loading tasks from Maak file: /etc/byggsteg/job-clone/guile-dokgen/trunk/maak.scm
Executing Maak tasks: test
--------------------------------------------------------------
=> Running Maak task: test
Run every test file under tests/.
SRFI-64 never turns a failure into an exit status, so each file goes through
`etc/run-test.scm', which does. The `test-module-*' files are fixtures the
suites document, not suites.
Execute command:
guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh -c 'set -eu
status=0
for file in tests/test-*.scm; do
case $file in tests/test-module-*) continue ;; esac
guile -L ./src -L . etc/run-test.scm "$file" || status=1
done
rm -f ./*.log
exit $status'
Executing: guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh -c 'set -eu
status=0
for file in tests/test-*.scm; do
case $file in tests/test-module-*) continue ;; esac
guile -L ./src -L . etc/run-test.scm "$file" || status=1
done
rm -f ./*.log
exit $status'
runmaak docs-check✓ succeeded20 lines · 1.0s
channels.scm:17:6: warning: channel 'jointhefreeworld' is not trusted
API documentation saved to manual/api
;;; note: source file /etc/byggsteg/job-clone/guile-dokgen/trunk/bin/../src/dokgen/cli.scm
;;; newer than compiled /root/.cache/guile/ccache/3.0-LE-8-4.7/etc/byggsteg/job-clone/guile-dokgen/trunk/src/dokgen/cli.scm.go
;;; note: auto-compilation is enabled, set GUILE_AUTO_COMPILE=0
;;; or pass the --no-auto-compile argument to disable.
;;; compiling /etc/byggsteg/job-clone/guile-dokgen/trunk/bin/../src/dokgen/cli.scm
;;; compiled /root/.cache/guile/ccache/3.0-LE-8-4.7/etc/byggsteg/job-clone/guile-dokgen/trunk/src/dokgen/cli.scm.go
--------------------------------------------------------------
Maak 0.14.0: the infinitely extensible command runner
Loading tasks from Maak file: /etc/byggsteg/job-clone/guile-dokgen/trunk/maak.scm
Executing Maak tasks: docs-check
--------------------------------------------------------------
=> Running Maak task: docs-check
Fail when manual/api/index.texi is not what the sources generate.
The reference is generated, so a committed copy that differs from a fresh one
is a procedure that was changed without the documentation following.
Execute command:
guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh bin/dokgen api --destination manual/api ./src/dokgen
Executing: guix time-machine --channels=channels.scm -- shell -m manifest.scm -- sh bin/dokgen api --destination manual/api ./src/dokgen
buildmaak manual✓ succeeded14 lines · 1.0s
--------------------------------------------------------------
Maak 0.14.0: the infinitely extensible command runner
Loading tasks from Maak file: /etc/byggsteg/job-clone/guile-dokgen/trunk/maak.scm
Executing Maak tasks: manual
--------------------------------------------------------------
=> Running Maak task: manual
Build the HTML manual into reports/manual.
channels.scm:17:6: warning: channel 'jointhefreeworld' is not trusted
manual/api/index.texi:85: warning: @end should only appear at the beginning of a line
manual/api/index.texi:399: warning: @end should only appear at the beginning of a line
Execute command:
guix time-machine --channels=channels.scm -- shell -m manifest.scm -- makeinfo --html --css-ref=https://jointhefreeworld.org/static/css/jointhefreeworld.css -c SHOW_TITLE=true -o reports/manual manual/main.texi
Executing: guix time-machine --channels=channels.scm -- shell -m manifest.scm -- makeinfo --html --css-ref=https://jointhefreeworld.org/static/css/jointhefreeworld.css -c SHOW_TITLE=true -o reports/manual manual/main.texi
open file:///etc/byggsteg/job-clone/guile-dokgen/trunk/reports/manual/index.html