RTEMS 5.1 documentation in docs.rtems.org

[Chris Johns]

On 29/10/20 12:54 am, Christian Mauderer wrote:
> Hello Jan,
> 
> On 28/10/2020 07:51, Jan.Sommer at dlr.de wrote:
>> Hello,
>>
>> If colleagues have RTEMS related questions, I like to direct them to docs.rtems.org to read the fine manual.
>> I noticed that in the releases section of the page 5.1 is not yet included.
> 
> You are right that there seem to be some missing links on the "All
> Releases" section and for the 5 branch.

I do apologise, I have not been able to get to this item because it is a thread
that once pulled drags me into a range of things I need to sort out and from
experience I can quickly sink a lot of time into it.

I am concerned adding the 5.1 docs and doxygen as the other releases are
currently being handled will fill the server's disk [1]. To avoid this I have
reworked the way the releases are handled to avoid filling the disk. Filling
this disk effects other critical things we have running such as git.

> To be honest: I have no idea where that would have to fixed.

I login into the service level of the machines behind the jail and then into the
docs.rtems.org jail. The access to the service machine is restricted.

Once into the jail I need to teach apache to follow the mount point to the
TrueNAS or I add HTML redirects as the click links. I am not sure which is the
better approach. Both have benefits and side effects.

I then need to update ..

https://git.rtems.org/chrisj/rtems-admin.git/tree/docs

... to manage the new location.

I then need to consider if the other releases are moved to the TrueNAS as well
and clearing that space on the disk that holds them.

>> Since with the work on RTEMS 6 the active branch documentation is diverging, could you please also add the 5.1 documentation there?
> 
> If you need something urgently: If you click on the "Latest Release
> Manuals" on the rtems.org start page, you reach the documentation for
> 5.1 that is saved on ftp.rtems.org:
> 
>   https://ftp.rtems.org/pub/rtems/releases/5/5.1/docs/html/

Thank you for providing the link. This is my solution I referred to above. I
have placed the documentation in the FTP release area that maps to the TrueNAS
storage which we have plenty of. There is a link (subtle to find) in the release
HTML page at:

https://ftp.rtems.org/pub/rtems/releases/5/5.1/#rtems-documentation

Another benefit of having the documentation here is a clone of the release tree
provides you with all the parts.

I hope this helps.

Chris

[1] https://devel.rtems.org/ticket/3138