Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 475332 - Links to eclass references inside the devmanual are broken
Summary: Links to eclass references inside the devmanual are broken
Status: RESOLVED DUPLICATE of bug 442194
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL: https://github.com/gentoo/devmanual.g...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-06-30 15:45 UTC by Johann Schmitz (ercpe) (RETIRED)
Modified: 2020-01-16 19:00 UTC (History)
0 users

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Johann Schmitz (ercpe) (RETIRED) gentoo-dev 2013-06-30 15:45:48 UTC
Whenever an eclass is referenced without an explicit link text, an <a>-Tag without link text is generated. E.g. the code

See <uri link="::eclass-reference/flag-o-matic.eclass/"/> for a full reference.

produces the following HTML snippet:

See <a href="../../../../eclass-reference/flag-o-matic.eclass/index.html"></a> for a full reference.

This is because the eclass-part isn't part of the devmanual sources (if I understand the other bugs correctly they are now generated from the man pages).
The make process actually warns about it:
  warning: failed to load external entity "eclass-reference/bash-completion.eclass/text.xml"

If a link text is specified as the text content of the <uri> tag, a proper <a> tag is generated.

Reproducible: Always
Comment 1 Johann Schmitz (ercpe) (RETIRED) gentoo-dev 2013-07-16 10:24:05 UTC
Just send a pull request for this issue (links to the eclass-reference have explicit link titles inside the <uri /> tag now).
Comment 2 Michael Palimaka (kensington) gentoo-dev 2013-07-16 10:34:54 UTC
Is this the same as bug #442194?
Comment 3 Johann Schmitz (ercpe) (RETIRED) gentoo-dev 2013-07-16 11:04:08 UTC
(In reply to Michael Palimaka (kensington) from comment #2)
> Is this the same as bug #442194?

Yes, guess I overlooked it.
Comment 4 Markos Chandras (RETIRED) gentoo-dev 2013-07-25 11:01:45 UTC
If this fixes the problem then we can merge the pull request and close the other bug.
Comment 5 Markos Chandras (RETIRED) gentoo-dev 2013-07-25 11:02:46 UTC
Can I see the resulting html with this patch applied?
Comment 6 Johann Schmitz (ercpe) (RETIRED) gentoo-dev 2013-07-25 16:32:46 UTC
(In reply to Markos Chandras from comment #4)
> If this fixes the problem then we can merge the pull request and close the
> other bug.

I think the approach in #442194 is the better one (fixing it in the generation script).
However, as a quick fix I would prefer merging the pull request (to get the links back) and revert it once the xslt or whatever is fixed if it is possible.
Comment 7 Markos Chandras (RETIRED) gentoo-dev 2013-08-17 09:22:29 UTC
(In reply to Johann Schmitz from comment #6)
> (In reply to Markos Chandras from comment #4)
> > If this fixes the problem then we can merge the pull request and close the
> > other bug.
> 
> I think the approach in #442194 is the better one (fixing it in the
> generation script).
> However, as a quick fix I would prefer merging the pull request (to get the
> links back) and revert it once the xslt or whatever is fixed if it is
> possible.

Pushed. Lets wait for devmanual to be regenerated again and see if the links are ok now
Comment 8 Johann Schmitz (ercpe) (RETIRED) gentoo-dev 2013-08-17 14:05:54 UTC
(In reply to Markos Chandras from comment #7)
> Pushed. Lets wait for devmanual to be regenerated again and see if the links
> are ok now

Seems to be ok now.
Comment 9 Markos Chandras (RETIRED) gentoo-dev 2013-08-20 08:52:13 UTC
The patch seems like it did the trick and fixed the broken references. thanks!
Comment 10 Larry the Git Cow gentoo-dev 2020-01-16 18:53:05 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=67b22764d134fdf6812efaa495c563ae1e639b9c

commit 67b22764d134fdf6812efaa495c563ae1e639b9c
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2020-01-15 20:08:13 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2020-01-16 18:49:08 +0000

    Revert "Fixed eclass-reference links"
    
    This is now fixed in devbook.xsl, so the changes in the text
    (which were meant as a stop-gap measure) can be reverted again.
    
    This reverts commit 481c88ea7ca8d93b17ac6668186216baf50daab9.
    
    Bug: https://bugs.gentoo.org/475332
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 appendices/contributors/text.xml                                | 2 +-
 ebuild-writing/functions/src_compile/build-environment/text.xml | 2 +-
 ebuild-writing/functions/src_compile/building/text.xml          | 5 +++--
 ebuild-writing/functions/src_unpack/svn-sources/text.xml        | 4 ++--
 ebuild-writing/using-eclasses/text.xml                          | 8 ++++----
 tasks-reference/completion/text.xml                             | 3 +--
 6 files changed, 12 insertions(+), 12 deletions(-)
Comment 11 Ulrich Müller gentoo-dev 2020-01-16 19:00:03 UTC

*** This bug has been marked as a duplicate of bug 442194 ***