Skip to content

Commit d177780

Browse files
roliver-rpitdewey-rpi
authored andcommitted
Clarify textual dependencies in documentation / packaging
Signed-off-by: Richard Oliver <[email protected]>
1 parent 05c40b5 commit d177780

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

README.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,13 @@ $ sudo reboot now
5959
Next, you will have to configure `rpi-sb-provisioner` by using the TUI. In a terminal, run:
6060

6161
----
62-
$ configure.sh
62+
$ config.sh
6363
----
6464

6565
WARNING: This will not work if you have not reboot after installing the package!
6666

67+
WARNING: `rpi-sb-provisioner' must be installed with `--install-suggests' for `config.sh' to work. This will require installation of `python3-textual' and `python3-rich' from Debian's Trixie release.
68+
6769
Running this command will open up a full screen text UI. The TUI supports mouse input or keyboard navigation!
6870
Each of the boxes contains a name, text entry and help button. The steps for editing each parameter are as follows:
6971

@@ -215,6 +217,8 @@ WARNING: `rpi-sb-provisioner` will not, by default, block JTAG access. If you wi
215217

216218
=== Monitoring via the monitoring application
217219

220+
WARNING: `rpi-sb-provisioner' must be installed with `--install-suggests' for `monitor.sh' to work. This will require installation of `python3-textual' and `python3-rich' from Debian's Trixie release.
221+
218222
`rpi-sb-provisioner` also contains a monitoring application. This can be used to observe the progress of a device as it is being provisioned. It also allows for easy introspection of the log files and lists all completed and failed devices.
219223
The monitoring application supports both mouse or keyboard input. Navigation between boxes can be acheived by using the `tab` key or by clicking on the desired area.
220224

nfpm.yaml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ depends:
143143
- dctrl-tools
144144
- diffutils
145145
- findutils
146-
- python3-textual
147146
- libengine-pkcs11-openssl
148147
- libp11-kit-dev
149148
- gnutls-bin
@@ -158,8 +157,21 @@ depends:
158157
# Suggested packages. (overridable)
159158
# This will expand any env var you set in the field, e.g. ${SUGGESTS_BLA}
160159
# the env var approach can be used to account for differences in platforms
161-
# suggests:
162-
# - bzr
160+
#
161+
# textual is a hard requirement for config.sh / monitor.sh but the version
162+
# packaged for Bookworm (0.1.13) does not implement features we depend upon.
163+
# At a minimum, we require 'The CSS Release' (0.2.0). As a more recent textual
164+
# package is available for Trixie (0.52.1), the dependencies have been listed
165+
# as 'suggests'.
166+
#
167+
# Debian's python3-textual (0.52.1-1) declares a dependency on python3-rich (>= 10.7.0),
168+
# but this is incorrect as (>= 13.3.3) is required due to use of Style.clear_meta_and_links.
169+
# clear_meta_and_links has been an upstream python3-textual requirement as of
170+
# (0.17.0). As such declare the dependencies below such that they can be
171+
# fulfilled by Debian's python3-textual, python3-rich Trixie packages.
172+
suggests:
173+
- python3-textual (>= 0.17.0)
174+
- python3-rich (>= 13.3.3)
163175

164176
# Packages it conflicts with. (overridable)
165177
# This will expand any env var you set in the field, e.g. ${CONFLICTS_BLA}

0 commit comments

Comments
 (0)