RTEMS / Documentation / Documentation¶
Go to Issues or Merge Requests
Issues Summary
Issues¶
151 - Backport to 6 branch “user: Update remaining references to autotools”¶
Id |
151 |
State |
closed |
Type |
ISSUE |
Author |
Kinsey Moore |
Assignee(s) |
Kinsey Moore |
Closed by |
Kinsey Moore |
Created |
2026-07-31T14:55:23.643Z |
Closed |
2026-08-13T23:08:01.572Z |
Updated |
2026-08-13T23:08:01.663Z |
Milestone |
6.3 |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/151 |
Merges |
0 |
The following discussion from !249 should be addressed:
[] @opticron started a discussion:
This needs a backport to 6 branch.
Author: Kinsey Moore
2026-07-31T14:55:23.824Z
added rtems#15 as parent item
Author: Kinsey Moore
2026-07-31T14:55:23.915Z
set status to To do
Author: Kinsey Moore
2026-07-31T14:55:24.017Z
assigned to @opticron
Author: Kinsey Moore
2026-07-31T16:24:18.736Z
mentioned in merge request !250
Author: Kinsey Moore
2026-07-31T17:20:05.841Z
set status to In progress
Author: Kinsey Moore
2026-08-13T23:08:01.635Z
set status to Done
160 - Build warnings on 5 branch with Python 3.14 (opened)¶
Id |
160 |
State |
opened |
Type |
ISSUE |
Author |
Chris Johns |
Assignee(s) |
Chris Johns |
Created |
2026-08-26T02:16:52.110Z |
Updated |
2026-08-26T02:17:07.182Z |
Milestone |
6.3 |
Labels |
doc |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/160 |
Merges |
0 |
Summary¶
Running waf with Python 3.14 has these warnings:
./waf configure --prefix=/opt/src/rtems/docs/test
/opt/work/chris/rtems/docs/rtems-docs.git/common/waf.py:104: SyntaxWarning: "\\D" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\D"? A raw string is also an option.
ver = tuple(map(int, re.split('[\\D]', version)))
/opt/work/chris/rtems/docs/rtems-docs.git/common/waf.py:111: SyntaxWarning: "\\D" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\D"? A raw string is also an option.
ver = tuple(map(int, re.split('[\\D]', version)))
/opt/work/chris/rtems/docs/rtems-docs.git/common/latex.py:9: SyntaxWarning: "\\d" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\\\d"? A raw string is also an option.
'\\documentclass[a4paper,11pt,english]{report}']
Author: Chris Johns
2026-08-26T02:16:52.232Z
cloned from #154
Author: Chris Johns
2026-08-26T02:17:03.952Z
added rtems#15 as parent item
Author: Chris Johns
2026-08-26T02:17:13.117Z
set status to In progress
Author: Chris Johns
2026-08-26T02:19:03.159Z
mentioned in merge request !258
158 - Update waf on 6 branch (opened)¶
Id |
158 |
State |
opened |
Type |
ISSUE |
Author |
Chris Johns |
Assignee(s) |
Chris Johns |
Created |
2026-08-25T06:42:15.656Z |
Updated |
2026-08-25T06:43:11.103Z |
Milestone |
6.3 |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/158 |
Merges |
0 |
We should use the latest which is 2.1.9.
Author: Chris Johns
2026-08-25T06:42:15.827Z
added rtems#15 as parent item
Author: Chris Johns
2026-08-25T06:42:15.920Z
set status to In progress
Author: Chris Johns
2026-08-25T06:42:16.063Z
assigned to @chris
Author: Chris Johns
2026-08-25T06:43:11.197Z
changed title from
Updat
r
e waf on 6 branch
to
Update waf on 6 branch
Author: Chris Johns
2026-08-25T06:45:16.124Z
mentioned in merge request !255
Author: Chris Johns
2026-08-26T14:22:14.355Z
mentioned in commit 2d65f5324eebad79b8a2fb4d90e16723c60efeae
157 - Docs version.py on 6 needs updating (opened)¶
Id |
157 |
State |
opened |
Type |
ISSUE |
Author |
Chris Johns |
Created |
2026-08-25T06:37:17.022Z |
Updated |
2026-08-25T06:37:47.263Z |
Milestone |
6.3 |
Labels |
doc |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/157 |
Merges |
0 |
Summary¶
Building a release set of docs on 5 raises this error:
Traceback (most recent call last):
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 119, in waf_entry_point
run_commands()
~~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 182, in run_commands
ctx=run_command(cmd_name)
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 173, in run_command
ctx.execute()
~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Scripting.py", line 375, in execute
return execute_method(self)
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Build.py", line 93, in execute
self.execute_build()
~~~~~~~~~~~~~~~~~~^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Build.py", line 96, in execute_build
self.recurse([self.run_dir])
~~~~~~~~~~~~^^^^^^^^^^^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/.waf3-2.0.19-1f3c580272b15a03d2566843c5fe872a/waflib/Context.py", line 133, in recurse
user_function(self)
~~~~~~~~~~~~~^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/wscript", line 85, in build
ver_version, ver_date, ver_released = version.get(ctx, rtems_major_version)
~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/opt/work/chris/rtems/releasing/rtems-release.git/5.4-rc2/ws-rtems-docs/rtems-docs-5.4-rc2/common/version.py", line 135, in get
v = configparser.SafeConfigParser()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: module 'configparser' has no attribute 'SafeConfigParser'. Did you mean: 'RawConfigParser'?
I guess pulling version.py from main would help if that version is also OK?
Author: Chris Johns
2026-08-25T06:37:17.148Z
cloned from #152
Author: Chris Johns
2026-08-25T06:37:31.989Z
added rtems#15 as parent item
Author: Chris Johns
2026-08-25T06:37:43.985Z
set status to In progress
Author: Chris Johns
2026-08-25T06:37:47.421Z
changed title from
Docs version.py on
5
needs updating
to
Docs version.py on
6
needs updating
Author: Chris Johns
2026-08-26T02:14:53.238Z
mentioned in merge request !257
93 - rtems-ver-minor set wrong in release? (opened)¶
Id |
93 |
State |
opened |
Type |
ISSUE |
Author |
Gedare Bloom |
Assignee(s) |
Gedare Bloom |
Created |
2025-02-27T16:51:58.067Z |
Updated |
2026-07-31T00:19:05.031Z |
Milestone |
6.3 |
Labels |
doc, release |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/93 |
Merges |
0 |
Summary¶
The minor number is 0 in the released docs for RTEMS 6.1
I’m not sure if this belongs to docs or release.
See for example https://docs.rtems.org/docs/6.1/user/start/sources.html#releases
@chris
Author: Gedare Bloom
2025-02-27T16:51:58.192Z
assigned to @gedare
Author: Chris Johns
2025-02-28T05:39:05.939Z
The 6.1 released docs can be found here https://ftp.rtems.org/pub/rtems/releases/6/6.1/docs/html/user/index.html and they look OK to me:
!`image.png <https://gitlab.rtems.org/-/project/uploads/0bd474ff5290a8c38a7b1783e937d97e/image.png>`_
@amar ?
Author: Chris Johns
2025-02-28T05:54:50.923Z
Checked docs.rtems.org and it also looks OK.
Author: Chris Johns
2025-10-02T22:36:06.067Z
added rtems#10 as parent epic
Author: Chris Johns
2025-12-16T20:45:23.300Z
added rtems#15 as parent epic
Author: Chris Johns
2026-07-31T00:19:05.004Z
Please update the Status.
54 - Details on windows builds (opened)¶
Id |
54 |
State |
opened |
Type |
ISSUE |
Author |
ita2048 ita2048 |
Assignee(s) |
Gedare Bloom |
Created |
2024-11-12T20:00:50.340Z |
Updated |
2026-07-31T00:10:34.260Z |
Milestone |
6.3 |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/work_items/54 |
Merges |
0 |
On Windows the build can be much more simple, and only four commands are needed from msys:
python3 -m venv sphinx # python 3.12.7 from msys
. sphinx/bin/activate
pip install sphinx sphinxcontrib-bibtex sphinxcontrib-jquery sphinx-copybutton sphinx-book-theme
./waf configure clean build install --prefix=/foo
On Windows, the
--singlehtmlcan be built after installinginliner:
pacman install unzip # required for `npm install`
install nvm from https://github.com/nvm-sh/nvm
nvm install --lts
npm install -g inliner
. sphinx/bin/activate
./waf configure clean build install --prefix=/foo --singlehtml
Author: Amar Takhar
2024-11-16T20:14:39.674Z
Per @ita2048 on Discord:
For the release: consider waf-2.1.4 (current version is 2.1.3 https://gitlab.rtems.org/rtems/rtos/rtems/-/blob/main/waf?ref_type=heads#L35) which enables native Python/Msys calls (also: [https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/54](https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/54 “https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/54”))
Author: Amar Takhar
2024-11-16T20:21:25.741Z
marked this issue as blocked by rtems/rtos/rtems#5153
Author: Gedare Bloom
2024-11-18T20:48:36.415Z
mentioned in merge request !85
Author: Gedare Bloom
2024-11-18T20:49:04.599Z
mentioned in merge request !86
Author: Gedare Bloom
2024-11-20T15:05:18.034Z
mentioned in commit 06dadefd69d89589015867ca4208464927d44b5b
Author: ita2048 ita2048
2024-11-25T18:15:05.016Z
~~New packages needed: ``pip install sphinx-copybutton sphinx-book-theme``~~
Author: ita2048 ita2048
2024-11-25T18:13:46.412Z
changed the description
Author: Gedare Bloom
2024-12-04T21:39:41.155Z
Author: Gedare Bloom
2024-12-04T22:26:43.010Z
marked this issue as blocked by rtems/rtos/rtems#5167
Author: Gedare Bloom
2024-12-04T22:26:49.176Z
removed the relation with rtems/rtos/rtems#5153
Author: Chris Johns
2024-12-06T00:07:26.844Z
changed the description
Author: Chris Johns
2025-01-16T23:35:35.658Z
assigned to @gedare
Author: Chris Johns
2025-01-16T23:35:41.499Z
Author: Chris Johns
2025-10-02T23:22:58.002Z
added rtems#15 as parent epic
Author: Chris Johns
2026-07-31T00:10:34.236Z
Please update the Status.
Merge Requests¶
258 - build: Fix python warnings¶
Id |
258 |
State |
merged |
Merged by |
Kinsey Moore |
Merged at |
2026-08-26T14:24:46.804Z |
Assignee(s) |
Chris Johns |
Created |
2026-08-26T02:18:56.924Z |
Updated |
2026-08-26T14:24:46.725Z |
Milestone |
6.3 |
Labels |
doc, tool::waf |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/258 |
Commit |
Summary¶
build: Fix python warnings
Closes #160
Generative AI¶
None
Author: Chris Johns
2026-08-26T02:18:57.117Z
assigned to @chris
Author: Chris Johns
2026-08-26T02:19:50.311Z
enabled an automatic merge when all merge checks for fee9bd15f798bd7f980182d031f9dc78dd87049a pass
Author: Chris Johns
2026-08-26T14:22:16.848Z
aborted the automatic merge because target branch was updated
Author: Kinsey Moore
2026-08-26T14:24:16.702Z
approved this merge request
Author: Kinsey Moore
2026-08-26T14:24:26.836Z
added 3 commits
fee9bd15…47bf011e - 2 commits from branch
rtems/docs:6ec0d16dc - build: Fix python warnings
Author: Kinsey Moore
2026-08-26T14:24:31.931Z
enabled an automatic merge when all merge checks for ec0d16dc69dcd2db6ed9cc2c323d7e6b5695a845 pass
Author: Joel Sherrill
2026-08-26T14:24:45.657Z
approved this merge request
257 - version: Fix building a release with Python 3.14¶
Id |
257 |
State |
merged |
Merged by |
Kinsey Moore |
Merged at |
2026-08-26T14:23:35.573Z |
Assignee(s) |
Chris Johns |
Created |
2026-08-26T02:14:46.781Z |
Updated |
2026-08-26T14:23:38.123Z |
Milestone |
6.3 |
Labels |
doc, tool::waf |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/257 |
Commit |
Summary¶
version: Fix building a release with Python 3.14
Closes #157
Generative AI¶
None
Author: Chris Johns
2026-08-26T02:14:46.962Z
assigned to @chris
Author: Chris Johns
2026-08-26T02:15:26.211Z
enabled an automatic merge when all merge checks for 4748127ecdc9e66b24f9e1cbae7c4a2a32dc9f2f pass
Author: Chris Johns
2026-08-26T14:22:14.968Z
aborted the automatic merge because target branch was updated
Author: Joel Sherrill
2026-08-26T14:22:51.343Z
approved this merge request
Author: Joel Sherrill
2026-08-26T14:23:00.306Z
added 2 commits
2d65f532 - 1 commit from branch
rtems/docs:647bf011e - version: Fix building a release with Python 3.14
255 - waf: Update to 2.1.9¶
Id |
255 |
State |
merged |
Merged by |
Chris Johns |
Merged at |
2026-08-26T14:22:12.995Z |
Assignee(s) |
Chris Johns |
Created |
2026-08-25T06:45:07.693Z |
Updated |
2026-08-26T14:22:12.986Z |
Milestone |
6.3 |
Labels |
doc, tool::waf |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/255 |
Commit |
Summary¶
waf: Update to 2.1.9
Closes #158
Generative AI¶
None
Author: Chris Johns
2026-08-25T06:45:08.607Z
assigned to @chris
Author: Chris Johns
2026-08-25T06:45:18.918Z
enabled an automatic merge when all merge checks for 2d65f5324eebad79b8a2fb4d90e16723c60efeae pass
Author: Joel Sherrill
2026-08-26T14:22:07.748Z
approved this merge request
253 - user/start/sources: Make release examples consistent¶
Id |
253 |
State |
merged |
Merged by |
Kinsey Moore |
Merged at |
2026-08-20T23:17:43.839Z |
Assignee(s) |
Kinsey Moore |
Created |
2026-08-18T13:50:13.681Z |
Updated |
2026-08-20T23:17:43.832Z |
Milestone |
6.3 |
Labels |
doc::user |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/253 |
Commit |
Summary¶
user/start/sources: Make release examples consistent
When version numbers were updated to replaceable references, this section was made confusing due to only part of the example getting updated. This makes the example self-consistent again.
Generative AI¶
Author: Kinsey Moore
2026-08-18T13:50:13.882Z
assigned to @opticron
Author: Kinsey Moore
2026-08-20T23:00:42.789Z
enabled an automatic merge when all merge checks for ef5ddcc15e41435a32e530709135e99e46c92592 pass
Author: Joel Sherrill
2026-08-20T23:17:41.140Z
approved this merge request
250 - user: Update remaining references to autotools¶
Id |
250 |
State |
merged |
Merged by |
Joel Sherrill |
Merged at |
2026-08-13T22:50:23.293Z |
Assignee(s) |
Kinsey Moore |
Created |
2026-07-31T16:24:12.591Z |
Updated |
2026-08-13T22:50:23.285Z |
Milestone |
6.3 |
Labels |
doc::user |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/250 |
Commit |
Summary¶
user: Update remaining references to autotools
This swaps the remaining references to autotools for their waf equivalents.
Closes #151
Generative AI¶
Author: Kinsey Moore
2026-07-31T16:24:12.891Z
assigned to @opticron
Author: Kinsey Moore
2026-07-31T16:24:29.468Z
enabled an automatic merge when all merge checks for 7f128af9a6034e8ea7d30f9df20a6150c6e5b9da pass
Author: Kinsey Moore
2026-07-31T16:24:49.863Z
marked this merge request as blocked by !249
Author: Kinsey Moore
2026-07-31T16:26:27.089Z
mentioned in issue rtems/rtos/rtems#4130
Author: Kinsey Moore
2026-08-13T22:42:54.018Z
added 2 commits
1df6cde3 - user: Update remaining references to autotools
cfdf4ec0 - Misc: Update instructions to not reference autoconf build system
Author: Joel Sherrill
2026-08-13T22:50:12.580Z
enabled an automatic merge when all merge checks for cfdf4ec0c64dd7b40dc5851bc3bf028cd6292b2c pass
Author: Joel Sherrill
2026-08-13T22:50:21.173Z
approved this merge request