[RTEMS Project] #4826: Software Engineering Guide has broken Reference

RTEMS trac trac at rtems.org
Fri Jan 27 14:08:24 UTC 2023


#4826: Software Engineering Guide has broken Reference
---------------------------+--------------------------
 Reporter:  Joel Sherrill  |       Owner:  Chris Johns
     Type:  defect         |      Status:  assigned
 Priority:  normal         |   Milestone:  6.1
Component:  doc            |     Version:
 Severity:  normal         |  Resolution:
 Keywords:                 |  Blocked By:
 Blocking:                 |
---------------------------+--------------------------
Changes (by Joel Sherrill):

 * owner:  (none) => Chris Johns
 * status:  new => assigned


Old description:

> Section 3, RTEMS Stakeholders, has a single paragraph which renders like
> this in the html at
> https://docs.rtems.org/branches/master/eng/stakeholders.html:
>

> {{{
> Please have a look at the Support and Contributing chapter of the ERROR:
> :r:url:`user`.
> }}}

New description:

 Section 3, RTEMS Stakeholders, has a single paragraph which renders like
 this in the html at
 https://docs.rtems.org/branches/master/eng/stakeholders.html:


 {{{
 Please have a look at the Support and Contributing chapter of the ERROR:
 :r:url:`user`.
 }}}

 A bit of investigation shows that it is trying to link to
 https://docs.rtems.org/branches/master/user/support/index.html. That
 section appears to be there correctly.

 Looking for documentation for the ":r:url:" syntax, I could not find any
 on the net. I see 48 uses of ":r:". I suspect but did not check that they
 all might be broken. What is ":r:" and what makes it work?

--

--
Ticket URL: <http://devel.rtems.org/ticket/4826#comment:1>
RTEMS Project <http://www.rtems.org/>
RTEMS Project


More information about the bugs mailing list