[rtems-docs commit] c-user: Generate Timer Manager documentation

Gedare Bloom gedare at rtems.org
Tue Dec 15 16:26:07 UTC 2020


[...]
>
> may change and may break. A release with the frozen code will point to
> those
> same pages for ever and that is broken no matter where the links are,
> source,
> comments or built and released documentation packages. The links should
> either
> refer to pages for that release, a link that we declare is stable or no
> link but
> a reference to chapter etc in a manual.
>
> +1

We should version cross-doc links, just like internal doc links implicitly
are versioned.

How that gets done is the key question here.

I don't mind adding more of the cross-doc links IF there is a plan in place
to sweep all of them at once to fix the versioning. Without a plan to fix
the links so they will work right when a release is cut, then I agree with
Chris, because it is putting technical debt on him and the release process.

Gedare
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20201215/b57a7dcf/attachment.html>


More information about the devel mailing list