Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 857066 - GLEP 2: "GLEP x" and "RFC x" aren't automatically linked
Summary: GLEP 2: "GLEP x" and "RFC x" aren't automatically linked
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: GLEP Changes (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: GLEP Editors
URL: https://www.gentoo.org/glep/glep-0002...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-07-08 20:22 UTC by Ulrich Müller
Modified: 2022-07-09 10:08 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Proposed patch for GLEP 2 (0001-glep-0002-GLEP-x-and-RFC-x-aren-t-automatically-link.patch,1.20 KB, patch)
2022-07-08 20:25 UTC, Ulrich Müller
Details | Diff
Proposed patch for GLEP 2 (0001-glep-0002-GLEP-x-and-RFC-x-aren-t-automatically-link.patch,1.30 KB, patch)
2022-07-09 08:39 UTC, Ulrich Müller
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2022-07-08 20:22:53 UTC
GLEP 2 says:
"Text of the form 'GLEP x' or 'RFC x' (where 'x' is a number) will be linked automatically to the appropriate URLs."

Our tooling rendering the HTML pages doesn't actually do that. Also, existing GLEPs tend to add explicit links for RFCs and other GLEPs, i.e. they don't assume that these are automatically linked.

The "glep" command from docutils-glep actually creates links for "RFC x" and "PEP x" but doesn't for "GLEP x". Presumably, this should be updated to agree with the above-mentioned tooling.

Proposal: Drop the sentence from GLEP 2.
Comment 1 Ulrich Müller gentoo-dev 2022-07-08 20:25:35 UTC
Created attachment 790727 [details, diff]
Proposed patch for GLEP 2
Comment 2 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2022-07-09 05:40:17 UTC
Shouldn't we bump GLEP version too?  Technically it's a breaking change.
Comment 3 Ulrich Müller gentoo-dev 2022-07-09 08:39:51 UTC
Created attachment 790763 [details, diff]
Proposed patch for GLEP 2
Comment 4 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2022-07-09 10:05:12 UTC
WFM.  I've confirmed that the website doesn't do this, and updated docutils-glep to match behavior on the master branch.  I'll make a new release once the GLEP update lands.
Comment 5 Larry the Git Cow gentoo-dev 2022-07-09 10:08:49 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/data/glep.git/commit/?id=fddc189901100b041343e935a1dabb09860f8932

commit fddc189901100b041343e935a1dabb09860f8932
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-07-08 20:23:54 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2022-07-09 08:38:45 +0000

    glep-0002: "GLEP x" and "RFC x" aren't automatically linked
    
    Closes: https://bugs.gentoo.org/857066
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 glep-0002.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)