Documentation | Define Style Rules for Referencing Issues in Comments (#23)

[Joel Sherrill (@joel)]

Joel Sherrill created an issue: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/23



## Summary
In reviewing changes to URLs found in comments in RTEMS, I noticed that it is impossible to tell if most of them are there to say there is an issue with the following code described in ticket X. Or if this is a reference to an issue which provides more information on a fixed problem and helps understand what's there.

But a comment that just cites a URL to an issue is lacking. We just need to define what we want when a ticket is referenced about an open or closed issue.

## Steps to reproduce

Just grep for https in RTEMS. :)

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/23
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20240726/977742a5/attachment.htm>