Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 194789 - dev-libs/boost - broken links in documentation
Summary: dev-libs/boost - broken links in documentation
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Development (show other bugs)
Hardware: x86 Linux
: High normal (vote)
Assignee: Tiziano Müller (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-10-05 10:53 UTC by Erik
Modified: 2007-11-18 12:16 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 Erik 2007-10-05 10:53:07 UTC
The documentation is almost unusable because of all the missing links.

Reproducible: Always

Steps to Reproduce:
1. Execute "emerge -u linkchecker boost".
2. Execute "linkchecker --ignore-url=^http: --no-warnings /usr/share/doc/boost-1.33.1-r1/html"
Actual Results:  
Plenty of errors, here is the summary:
That's it. 40406 links checked. 12137 warnings found. 2935 errors found.
Comment 1 Erik 2007-10-05 18:00:03 UTC
I have now unmasked dev-libs/boost-1.34.1, emerged it and executed linkchecker on it. There are still problems. Summary:
That's it. 76774 links checked. 11399 warnings found. 4322 errors found.
Comment 2 Tiziano Müller (RETIRED) gentoo-dev 2007-10-06 18:31:05 UTC
Well, I can browse the documention here, except for the boost-logo which doesn't get displayed.
Can you please be more specific?
Comment 3 Erik 2007-10-06 19:31:43 UTC
Have you tried the steps to reproduce it? linkchecker shows plenty of errors. What does it show for you?
Comment 4 Tiziano Müller (RETIRED) gentoo-dev 2007-10-06 20:14:57 UTC
Well, I don't care what the linkchecker says. I only care whether I can browse the docs and whether I can read up the infos for the header-files/classes, etc. And this works.
Comment 5 Erik 2007-10-07 00:53:34 UTC
Linkchecker is a tool that reports broken links, which prevent browsing. If an image link is broken, the browser will show a special icon indicating this (and show a text that can be given in the alt="text" part of the image link) instead of showing the intended image. If a normal link is broken, the user will not get to the intended page. Instead he will see a page with an error message. None of this should happen. So you should care about what linkchecker says. You already mentioned that a logo was missing. That is one of the problems that linkchecker reports.

I tried to read the documentation for boost-1.33.1-r1 and half of the documentation was just missing. Therefore I installed linkckecker to analyze the problem and reported it. Then I unmasked boost-1.34 and discovered that it is indeed much better. But there are still broken links. If only boost.png was added, many of the reported problems would vanish. There are also very many broken links to [file:///usr/share/doc/boost-1.34.1/html/LICENSE_1_0.txt]. Then it seems like all the links to source files are broken as well. Just look at for example [/usr/share/doc/boost-1.34.1/html/libs/format/index.html], which links to for example [file:///usr/share/doc/boost-1.34.1/html/boost/format/format_fwd.hpp], which does not exist. I suppose the link should be changed to point to [file:///usr/include/boost/format/format_fwd.hpp] instead.

So if you care to fix this, add boost.png, LICENSE_1_0.txt and fix the links to source files. Then use linkchecker to make sure there are no other problems left. Then release the new version and remove the old versions with broken documentation.
Comment 6 Tiziano Müller (RETIRED) gentoo-dev 2007-11-18 12:16:13 UTC
Ok, all link-errors fixed besides the ones pointing to boost-build, regression-tests and examples.

Cheers.