From 4b7e696d91456cc14ca0a6f5ecdd935458cfc9a8 Mon Sep 17 00:00:00 2001 From: Luca Toniolo <10792599+grandixximo@users.noreply.github.com> Date: Wed, 19 Aug 2026 12:51:06 +1000 Subject: [PATCH 1/2] docs: fix broken lcnc_realtime cross-references in python-hal-interface The three links to the LinuxCNC realtime check used inter-document xref syntax (xref:python-lcnc_realtime.adoc[]). The documentation is built as a single book, so asciidoctor emitted href="#python-lcnc_realtime.adoc", a fragment that does not exist anywhere in the output. htmlcheck.sh reported the resulting broken fragments for every language. Use the anchor the target chapter actually declares, <>, matching the reference style already used in hal/halmodule.adoc. --- docs/src/config/python-hal-interface.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/config/python-hal-interface.adoc b/docs/src/config/python-hal-interface.adoc index 55f52eacf5f..00ec2cf878e 100644 --- a/docs/src/config/python-hal-interface.adoc +++ b/docs/src/config/python-hal-interface.adoc @@ -157,9 +157,9 @@ System information: * `hal.kernel_version` - A string specifying the real-time kernel version if `hal.is_kernelspace` is one. Otherwise it specifies `"Not Available"`. * `hal.is_rt` - One (1) if the system runs in real-time, otherwise zero (0) *DEPRECATED*: - Use xref:python-lcnc_realtime.adoc[`lcnc_realtime.verify()`] + Use <> * `hal.is_sim` - Inverted `hal.is_rt` *DEPRECATED*: - Use xref:python-lcnc_realtime.adoc[`lcnc_realtime.verify()`] + Use <> === hal methods @@ -180,7 +180,7 @@ hal.get_realtime_type() -> hal.RTType:: Returns the type of the running realtime system. Might return `hal.RTType.UNINITIALIZED` if `rtapi_app` is not running. See xref:halconstantsrt[realtime type constants]. -See also xref:python-lcnc_realtime.adoc[LinuxCNC Realtime check]. +See also <>. hal.component_exists(_name_:string) -> bool:: Returns a boolean to indicate whether or not the specified component exist at this time. From 8da75f1a8f39d8b39236c1e960826c49dd788550 Mon Sep 17 00:00:00 2001 From: Luca Toniolo <10792599+grandixximo@users.noreply.github.com> Date: Wed, 19 Aug 2026 12:51:06 +1000 Subject: [PATCH 2/2] docs: use a listing block instead of a markdown fence in hm2_rpspi.9 The rc.local example was written as a markdown-style ``` fenced block. Asciidoctor renders that correctly for English, but po4a's asciidoc parser does not recognise the fences: it extracts the block as an ordinary paragraph and reflows it onto one line. In every translated build the opening fence then read as an unterminated listing block, so asciidoctor warned about it and swallowed the rest of the page. The German manpage, for example, lost the NOTE, AUTHOR and LICENSE sections entirely and put the shell commands in a data-lang attribute. With a proper ---- listing block po4a classifies it as a verbatim block and keeps the line breaks, and the translated pages render in full. --- docs/src/man/man9/hm2_rpspi.9.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/man/man9/hm2_rpspi.9.adoc b/docs/src/man/man9/hm2_rpspi.9.adoc index 766864e8061..ba577b8353e 100644 --- a/docs/src/man/man9/hm2_rpspi.9.adoc +++ b/docs/src/man/man9/hm2_rpspi.9.adoc @@ -178,10 +178,10 @@ throwing off the SoC's PLL(s), resulting in strange behaviour. For optimal performance on the RPi3, you must disable the "ondemand" CPU frequency governor. You may add the following to your /etc/rc.local file: -``` +---- echo -n 1200000 > /sys/devices/system/cpu/cpufreq/policy0/scaling_min_freq echo -n performance > /sys/devices/system/cpu/cpufreq/policy0/scaling_governor -``` +---- Be sure to have a proper heatsink mounted on the SoC or it will get too warm and crashes.