RTEMS / Documentation / Documentation¶
Go to Issues or Merge Requests
Issues¶
6 - Merge Request Approval process is broken¶
Id |
6 |
State |
closed |
Type |
ISSUE |
Author |
Gedare Bloom |
Assignee(s) |
Amar Takhar, Gedare Bloom |
Closed by |
Amar Takhar |
Created |
2024-05-02T03:44:41.017Z |
Closed |
2024-07-08T04:18:12.604Z |
Updated |
2024-07-08T04:18:12.616Z |
Milestone |
6.2 |
Link |
|
Merges |
2 |
Summary¶
The approver flow in this repo requires 1 general approver and does not require 1 maintainer approver.
See also https://gitlab.rtems.org/administration/gitlab/-/issues/6
Steps to reproduce¶
Author: Gedare Bloom
2024-05-02T03:44:41.109Z
assigned to @gedare
Author: Amar Takhar
2024-05-02T03:57:25.218Z
marked this issue as related to administration/gitlab#6
Author: Amar Takhar
2024-05-02T03:57:54.881Z
FYI the ‘linked items’ section is handy keeps things more organised and will combine certain things
Author: Gedare Bloom
2024-05-02T04:07:03.082Z
created branch 6-merge-request-approval-process-is-broken to address this issue
Author: Gedare Bloom
2024-05-02T04:07:34.064Z
mentioned in merge request !6
Author: Gedare Bloom
2024-05-02T04:51:03.785Z
mentioned in merge request !7
Author: Gedare Bloom
2024-05-02T05:18:58.469Z
See https://gitlab.rtems.org/gedare/rtems-docs/-/commit/e59b13dd40f52a3d831967795b70a1681acbb84b for a proof-of-concept patch.
The basic logic is to make the General Approvers section optional, and to require at least 1 approval from the Maintainer Approvers section.
Now, since only 1 approval is required in the repo settings, this means the General Approvers approval is purely optional/advisory, as at least 1 Maintainer would still need to approve an MR.
Author: Amar Takhar
2024-05-17T00:39:46.439Z
assigned to @amar
Author: Amar Takhar
2024-07-08T04:18:12.376Z
We have been running this for over a month now it is all working as we want.
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 |
2025-02-28T05:59:17.888Z |
Milestone |
6.2 |
Labels |
doc, release |
Link |
|
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.
73 - posix_rst.py: Correct Spelling of Application (opened)¶
Id |
73 |
State |
opened |
Type |
ISSUE |
Author |
Joel Sherrill |
Assignee(s) |
Joel Sherrill |
Created |
2025-01-27T22:35:09.249Z |
Updated |
2025-01-27T23:52:11.785Z |
Milestone |
6.2 |
Link |
|
Merges |
0 |
Summary¶
This issue is to correct the spelling of “Application” in the posix_rst.py program. This spelling error propagates into the headings of the generated documentation.
Pre-set options¶
Author: Joel Sherrill
2025-01-27T22:35:09.411Z
assigned to @joel
Author: Joel Sherrill
2025-01-27T22:35:13.341Z
Author: Joel Sherrill
2025-01-27T23:52:11.701Z
mentioned in merge request !141
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 |
2025-01-16T23:35:46.114Z |
Milestone |
6.2 |
Link |
|
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
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
46 - Fix broken links on https://www.rtems.org/architectures/ (opened)¶
Id |
46 |
State |
opened |
Type |
ISSUE |
Author |
ita2048 ita2048 |
Assignee(s) |
Amar Takhar |
Created |
2024-11-01T12:23:45.281Z |
Updated |
2024-12-06T00:02:13.711Z |
Milestone |
6.2 |
Labels |
doc |
Link |
|
Merges |
0 |
Summary¶
Please highlight the value of Rtems in the architecture page:
All links point to a blank page
We are working on content this page is intentionally left blankwith an additional link to the source code. Please point to the pages in the reference documentation such as https://docs.rtems.org/branches/master/cpu-supplement/arm.html, or to the source code directly if that’s the intention. Right now there is no point in consulting this architectures page.Why mention “obsoleted ports” at all on this page? Can that information be moved to a page specific to a particular release, for example https://docs.rtems.org/branches/master/cpu-supplement/preface.html ?
What is the process for having new supported architectures and what are the future plans for the RTEMS project?
Author: Chris Johns
2024-11-07T23:37:18.698Z
assigned to @amar
Author: Gedare Bloom
2024-12-04T21:39:40.423Z
Author: Chris Johns
2024-12-06T00:02:18.152Z
Merge Requests¶
151 - gitlab: Add link to CI¶
Id |
151 |
State |
merged |
Merged by |
Kinsey Moore |
Merged at |
2025-02-14T16:36:09.703Z |
Assignee(s) |
Amar Takhar |
Created |
2025-02-14T04:02:08.918Z |
Updated |
2025-02-14T16:36:11.054Z |
Milestone |
6.2 |
Labels |
ci |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/151 |
Commit |
Summary¶
gitlab: Add link to CI
This runs only the commit message and merge request checker.
Required so we can have ‘all pipelines must pass’ enabled due to a bug in GitLab.
Author: Amar Takhar
2025-02-14T04:02:09.144Z
assigned to @amar
Author: Kinsey Moore
2025-02-14T16:35:20.085Z
added 6 commits
356614bc…9ad29e1c - 5 commits from branch
rtems/docs:60bc67a11 - gitlab: Add link to CI
Author: Kinsey Moore
2025-02-14T16:35:35.678Z
approved this merge request
141 - posix-compliance/posix_rst.py: Spell application correctly¶
Id |
141 |
State |
merged |
Merged by |
Kinsey Moore |
Merged at |
2025-01-28T01:56:52.534Z |
Assignee(s) |
Joel Sherrill |
Created |
2025-01-27T23:52:05.883Z |
Updated |
2025-01-28T01:56:53.516Z |
Milestone |
6.2 |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/141 |
Commit |
Summary¶
posix-compliance/posix_rst.py: Spell application correctly
Closes #73
Author: Joel Sherrill
2025-01-27T23:52:06.085Z
assigned to @joel
Author: Kinsey Moore
2025-01-28T01:56:45.539Z
approved this merge request
92 - README: Update to book theme¶
Id |
92 |
State |
merged |
Merged by |
Chris Johns |
Merged at |
2024-11-22T06:16:51.135Z |
Reviewer(s) |
Chris Johns |
Created |
2024-11-22T06:11:14.520Z |
Updated |
2024-11-22T06:16:52.219Z |
Milestone |
6.2 |
Link |
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/92 |
Commit |
Summary¶
README: Update to book theme
(cherry picked from commit 3aa5a1aeef00fab266c07c4a732401f28a1eec45)
7ec1823f README: Update to book theme 3c7eb1e2 Update README.md 7619a2c7 Update README.md
Co-authored-by: Chris Johns <chrisj@rtems.org>
Author: Gedare Bloom
2024-11-22T06:11:14.682Z
requested review from @chris
Author: Chris Johns
2024-11-22T06:16:44.670Z
approved this merge request