* broken links @ 2021-01-07 16:52 Nicolas Dechesne 2021-01-07 16:59 ` [docs] " Quentin Schulz 0 siblings, 1 reply; 8+ messages in thread From: Nicolas Dechesne @ 2021-01-07 16:52 UTC (permalink / raw) To: YP docs mailing list, Robert Berger [-- Attachment #1: Type: text/plain, Size: 4117 bytes --] hey! Robert opened a bug for a broken link in the doc, see https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 This is a valid bug, a regression in e1bcfe4d8 dev-manual: remove unused labels Unfortunately, it opens a can of worms... since it looks like the built in linkcheck did not detect the broken links, and this is not the only broken link. I ran an online link checker on https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it reported the following errors with anchors.. they look like they are regression with the commit above.. https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-fetching-code (line 1783) https://docs.yoctoproject.org/dev-manual/common-tasks.html#qemu-image-running-tests (line 8164) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-debugging-viewing-logs-from-failed-tasks (line 8594) https://docs.yoctoproject.org/dev-manual/common-tasks.html#wic-using-the-wic-plugin-interface (line 5148) https://docs.yoctoproject.org/dev-manual/common-tasks.html#best-practices-to-follow-when-creating-layers (line 6101) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-single-c-file-package-hello-world (line 1696) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-storing-and-naming-the-recipe (line 2356) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-autotooled-package (line 1622) https://docs.yoctoproject.org/dev-manual/common-tasks.html#usingpoky-extend-customimage (line 2434) https://docs.yoctoproject.org/dev-manual/common-tasks.html#combining-multiple-versions-library-files-into-one-image (line 4671) https://docs.yoctoproject.org/dev-manual/common-tasks.html#using-bbappend-files (line 6107) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-viewing-task-variable-dependencies (lines 8610, 8919) https://docs.yoctoproject.org/dev-manual/common-tasks.html#platdev-gdb-remotedebug (line 8634) https://docs.yoctoproject.org/dev-manual/common-tasks.html#wic-requirements (line 5545) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-viewing-dependencies-between-recipes-and-tasks (line 8606) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-other-debugging-others (line 8641) https://docs.yoctoproject.org/dev-manual/common-tasks.html#platdev-appdev-devshell (line 9299) https://docs.yoctoproject.org/dev-manual/common-tasks.html#how-to-submit-a-change (line 9393) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-debugging-buildfile (line 8623) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-makefile-based-package (line 2069) https://docs.yoctoproject.org/dev-manual/common-tasks.html#incrementing-a-binary-package-version (line 6199) https://docs.yoctoproject.org/dev-manual/common-tasks.html#using-a-quilt-workflow (line 9337) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-debugging-taskrunning (line 8616) https://docs.yoctoproject.org/dev-manual/common-tasks.html#finding-the-temporary-source-code (line 3504) https://docs.yoctoproject.org/dev-manual/common-tasks.html#automatically-incrementing-a-binary-package-revision-number (line 6290) https://docs.yoctoproject.org/dev-manual/common-tasks.html#using-a-provided-kickstart-file (line 5134) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-debugging-bitbake (line 8620) https://docs.yoctoproject.org/dev-manual/common-tasks.html#figuring-out-the-mailing-list-to-use (line 9920) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-post-installation-scripts (line 2201) https://docs.yoctoproject.org/dev-manual/common-tasks.html#dev-debugging-viewing-variable-values (line 8598) https://docs.yoctoproject.org/dev-manual/common-tasks.html#understand-what-gives-your-image-size (line 4024) https://docs.yoctoproject.org/dev-manual/common-tasks.html#new-recipe-patching-code (line 1703) Anyone have any recommendations on how to configure the builtin linkcheck so that it reports such errors? cheers nico [-- Attachment #2: Type: text/html, Size: 7958 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-01-07 16:52 broken links Nicolas Dechesne @ 2021-01-07 16:59 ` Quentin Schulz 2021-01-07 17:08 ` Nicolas Dechesne 0 siblings, 1 reply; 8+ messages in thread From: Quentin Schulz @ 2021-01-07 16:59 UTC (permalink / raw) To: Nicolas Dechesne; +Cc: YP docs mailing list, Robert Berger Hi Nicolas, On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > hey! > > Robert opened a bug for a broken link in the doc, see > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > > This is a valid bug, a regression in > e1bcfe4d8 dev-manual: remove unused labels > > Unfortunately, it opens a can of worms... since it looks like the built in > linkcheck did not detect the broken links, and this is not the only broken > link. > > I ran an online link checker on > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it reported > the following errors with anchors.. they look like they are regression with > the commit above.. > [...] It'd be nice to fix the linkcheck indeed. I have on my todolist to remove all anchor links to use refs instead but it's not fun work to do and it's time consuming. I can now probably "automate" all of this with some python regexp and manually fix the ones returned by your online link checker :) (and use the online link checker to validate the changes). I'd then add in the README/CONTRIBUTING that we do not allow such links and we have to be careful to enforce this when receiving patches. All this in the event that we can't find what's wrong with our linkcheck. Cheers, Quentin ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-01-07 16:59 ` [docs] " Quentin Schulz @ 2021-01-07 17:08 ` Nicolas Dechesne 2021-01-13 18:26 ` Nicolas Dechesne 0 siblings, 1 reply; 8+ messages in thread From: Nicolas Dechesne @ 2021-01-07 17:08 UTC (permalink / raw) To: Quentin Schulz; +Cc: YP docs mailing list, Robert Berger [-- Attachment #1: Type: text/plain, Size: 1561 bytes --] On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < quentin.schulz@streamunlimited.com> wrote: > Hi Nicolas, > > On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > > hey! > > > > Robert opened a bug for a broken link in the doc, see > > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > > > > This is a valid bug, a regression in > > e1bcfe4d8 dev-manual: remove unused labels > > > > Unfortunately, it opens a can of worms... since it looks like the built > in > > linkcheck did not detect the broken links, and this is not the only > broken > > link. > > > > I ran an online link checker on > > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it > reported > > the following errors with anchors.. they look like they are regression > with > > the commit above.. > > > > [...] > > It'd be nice to fix the linkcheck indeed. > hmm. could it be that linkcheck only checks for 'external' links? > > I have on my todolist to remove all anchor links to use refs instead but > it's > not fun work to do and it's time consuming. I can now probably "automate" > all of this with some python regexp and manually fix the ones returned > by your online link checker :) (and use the online link checker to > validate the changes). > > I'd then add in the README/CONTRIBUTING that we do not allow such links > and we have to be careful to enforce this when receiving patches. > > All this in the event that we can't find what's wrong with our > linkcheck. > > Cheers, > Quentin > [-- Attachment #2: Type: text/html, Size: 2416 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-01-07 17:08 ` Nicolas Dechesne @ 2021-01-13 18:26 ` Nicolas Dechesne 2021-04-07 16:12 ` Quentin Schulz 0 siblings, 1 reply; 8+ messages in thread From: Nicolas Dechesne @ 2021-01-13 18:26 UTC (permalink / raw) To: Quentin Schulz; +Cc: YP docs mailing list, Robert Berger [-- Attachment #1: Type: text/plain, Size: 5531 bytes --] On Thu, Jan 7, 2021 at 6:08 PM Nicolas Dechesne <nicolas.dechesne@linaro.org> wrote: > > > On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < > quentin.schulz@streamunlimited.com> wrote: > >> Hi Nicolas, >> >> On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: >> > hey! >> > >> > Robert opened a bug for a broken link in the doc, see >> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 >> > >> > This is a valid bug, a regression in >> > e1bcfe4d8 dev-manual: remove unused labels >> > >> > Unfortunately, it opens a can of worms... since it looks like the built >> in >> > linkcheck did not detect the broken links, and this is not the only >> broken >> > link. >> > >> > I ran an online link checker on >> > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it >> reported >> > the following errors with anchors.. they look like they are regression >> with >> > the commit above.. >> > >> >> [...] >> >> It'd be nice to fix the linkcheck indeed. >> > > hmm. could it be that linkcheck only checks for 'external' links? > in the meantime I was looking for a tool I could run locally, and found [1] It looks like it gives some good output: $ pytest --check-links --check-anchors --check-links-cache _build/html/dev-manual/ FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-autotooled-package> FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-single-c-file-package-hello-world> FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-patching-code> FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-fetching-code> FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-post-installation-scripts> FAILED _build/html/dev-manual/common-tasks.html <a href=#new-recipe-storing-and-naming-the-recipe> FAILED _build/html/dev-manual/common-tasks.html <a href=#usingpoky-extend-customimage> FAILED _build/html/dev-manual/common-tasks.html <a href=#finding-the-temporary-source-code> FAILED _build/html/dev-manual/common-tasks.html <a href=#understand-what-gives-your-image-size> FAILED _build/html/dev-manual/common-tasks.html <a href=#combining-multiple-versions-library-files-into-one-image> FAILED _build/html/dev-manual/common-tasks.html <a href=#using-a-provided-kickstart-file> FAILED _build/html/dev-manual/common-tasks.html <a href=#wic-using-the-wic-plugin-interface> FAILED _build/html/dev-manual/common-tasks.html <a href=#wic-requirements> FAILED _build/html/dev-manual/common-tasks.html <a href=#best-practices-to-follow-when-creating-layers> FAILED _build/html/dev-manual/common-tasks.html <a href=#using-bbappend-files> FAILED _build/html/dev-manual/common-tasks.html <a href=#incrementing-a-binary-package-version> FAILED _build/html/dev-manual/common-tasks.html <a href=#automatically-incrementing-a-binary-package-revision-number> FAILED _build/html/dev-manual/common-tasks.html <a href=#qemu-image-running-tests> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-debugging-viewing-logs-from-failed-tasks> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-debugging-viewing-variable-values> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-viewing-dependencies-between-recipes-and-tasks> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-viewing-task-variable-dependencies> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-debugging-taskrunning> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-debugging-bitbake> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-debugging-buildfile> FAILED _build/html/dev-manual/common-tasks.html <a href=#platdev-gdb-remotedebug> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-other-debugging-others> FAILED _build/html/dev-manual/common-tasks.html <a href=#dev-viewing-task-variable-dependencies> FAILED _build/html/dev-manual/common-tasks.html <a href=#platdev-appdev-devshell> FAILED _build/html/dev-manual/common-tasks.html <a href=#using-a-quilt-workflow> FAILED _build/html/dev-manual/common-tasks.html <a href=#how-to-submit-a-change> FAILED _build/html/dev-manual/common-tasks.html <a href=#figuring-out-the-mailing-list-to-use> FAILED _build/html/dev-manual/qemu.html <a href=#qemu-running-under-a-network-file-system-nfs-server> FAILED _build/html/dev-manual/qemu.html <a href=#kvm-cond> FAILED _build/html/dev-manual/start.html <a href= https://autobuilder.yocto.io//pub/nightly/> FAILED _build/html/dev-manual/start.html <a href= https://autobuilder.yocto.io//pub/nightly/> FAILED _build/html/dev-manual/start.html <a href=#checkout-out-by-tag-in-poky> It's slow, it took 7 minutes to check for the dev-manual.. but it's a first step. now we need to fix them! [1] https://github.com/jupyterlab/pytest-check-links > >> >> I have on my todolist to remove all anchor links to use refs instead but >> it's >> not fun work to do and it's time consuming. I can now probably "automate" >> all of this with some python regexp and manually fix the ones returned >> by your online link checker :) (and use the online link checker to >> validate the changes). >> >> I'd then add in the README/CONTRIBUTING that we do not allow such links >> and we have to be careful to enforce this when receiving patches. >> >> All this in the event that we can't find what's wrong with our >> linkcheck. >> >> Cheers, >> Quentin >> > [-- Attachment #2: Type: text/html, Size: 7428 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-01-13 18:26 ` Nicolas Dechesne @ 2021-04-07 16:12 ` Quentin Schulz 2021-04-07 16:40 ` Nicolas Dechesne 0 siblings, 1 reply; 8+ messages in thread From: Quentin Schulz @ 2021-04-07 16:12 UTC (permalink / raw) To: Nicolas Dechesne; +Cc: YP docs mailing list, Robert Berger On Wed, Jan 13, 2021 at 07:26:17PM +0100, Nicolas Dechesne wrote: > On Thu, Jan 7, 2021 at 6:08 PM Nicolas Dechesne <nicolas.dechesne@linaro.org> > wrote: > > > > > > > On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < > > quentin.schulz@streamunlimited.com> wrote: > > > >> Hi Nicolas, > >> > >> On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > >> > hey! > >> > > >> > Robert opened a bug for a broken link in the doc, see > >> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > >> > > >> > This is a valid bug, a regression in > >> > e1bcfe4d8 dev-manual: remove unused labels > >> > > >> > Unfortunately, it opens a can of worms... since it looks like the built > >> in > >> > linkcheck did not detect the broken links, and this is not the only > >> broken > >> > link. > >> > > >> > I ran an online link checker on > >> > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it > >> reported > >> > the following errors with anchors.. they look like they are regression > >> with > >> > the commit above.. > >> > > >> > >> [...] > >> > >> It'd be nice to fix the linkcheck indeed. > >> > > > > hmm. could it be that linkcheck only checks for 'external' links? > > > > in the meantime I was looking for a tool I could run locally, and found [1] > > It looks like it gives some good output: > > $ pytest --check-links --check-anchors --check-links-cache > _build/html/dev-manual/ > > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-autotooled-package> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-single-c-file-package-hello-world> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-patching-code> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-fetching-code> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-post-installation-scripts> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#new-recipe-storing-and-naming-the-recipe> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#usingpoky-extend-customimage> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#finding-the-temporary-source-code> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#understand-what-gives-your-image-size> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#combining-multiple-versions-library-files-into-one-image> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#using-a-provided-kickstart-file> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#wic-using-the-wic-plugin-interface> > FAILED _build/html/dev-manual/common-tasks.html <a href=#wic-requirements> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#best-practices-to-follow-when-creating-layers> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#using-bbappend-files> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#incrementing-a-binary-package-version> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#automatically-incrementing-a-binary-package-revision-number> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#qemu-image-running-tests> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-debugging-viewing-logs-from-failed-tasks> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-debugging-viewing-variable-values> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-viewing-dependencies-between-recipes-and-tasks> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-viewing-task-variable-dependencies> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-debugging-taskrunning> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-debugging-bitbake> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-debugging-buildfile> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#platdev-gdb-remotedebug> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-other-debugging-others> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#dev-viewing-task-variable-dependencies> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#platdev-appdev-devshell> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#using-a-quilt-workflow> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#how-to-submit-a-change> > FAILED _build/html/dev-manual/common-tasks.html <a > href=#figuring-out-the-mailing-list-to-use> > FAILED _build/html/dev-manual/qemu.html <a > href=#qemu-running-under-a-network-file-system-nfs-server> > FAILED _build/html/dev-manual/qemu.html <a href=#kvm-cond> > FAILED _build/html/dev-manual/start.html <a href= > https://autobuilder.yocto.io//pub/nightly/> > FAILED _build/html/dev-manual/start.html <a href= > https://autobuilder.yocto.io//pub/nightly/> > FAILED _build/html/dev-manual/start.html <a > href=#checkout-out-by-tag-in-poky> > > It's slow, it took 7 minutes to check for the dev-manual.. but it's a first > step. now we need to fix them! > > [1] https://github.com/jupyterlab/pytest-check-links > In the end, I went for htmltest to test links: https://github.com/wjdp/htmltest ~5min for the whole documentation. Not too bad :) Cheers, Quentin ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-04-07 16:12 ` Quentin Schulz @ 2021-04-07 16:40 ` Nicolas Dechesne 2021-04-07 16:47 ` Quentin Schulz 0 siblings, 1 reply; 8+ messages in thread From: Nicolas Dechesne @ 2021-04-07 16:40 UTC (permalink / raw) To: Quentin Schulz; +Cc: YP docs mailing list, Robert Berger [-- Attachment #1: Type: text/plain, Size: 6132 bytes --] On Wed, Apr 7, 2021 at 6:12 PM Quentin Schulz < quentin.schulz@streamunlimited.com> wrote: > On Wed, Jan 13, 2021 at 07:26:17PM +0100, Nicolas Dechesne wrote: > > On Thu, Jan 7, 2021 at 6:08 PM Nicolas Dechesne < > nicolas.dechesne@linaro.org> > > wrote: > > > > > > > > > > > On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < > > > quentin.schulz@streamunlimited.com> wrote: > > > > > >> Hi Nicolas, > > >> > > >> On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > > >> > hey! > > >> > > > >> > Robert opened a bug for a broken link in the doc, see > > >> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > > >> > > > >> > This is a valid bug, a regression in > > >> > e1bcfe4d8 dev-manual: remove unused labels > > >> > > > >> > Unfortunately, it opens a can of worms... since it looks like the > built > > >> in > > >> > linkcheck did not detect the broken links, and this is not the only > > >> broken > > >> > link. > > >> > > > >> > I ran an online link checker on > > >> > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it > > >> reported > > >> > the following errors with anchors.. they look like they are > regression > > >> with > > >> > the commit above.. > > >> > > > >> > > >> [...] > > >> > > >> It'd be nice to fix the linkcheck indeed. > > >> > > > > > > hmm. could it be that linkcheck only checks for 'external' links? > > > > > > > in the meantime I was looking for a tool I could run locally, and found > [1] > > > > It looks like it gives some good output: > > > > $ pytest --check-links --check-anchors --check-links-cache > > _build/html/dev-manual/ > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-autotooled-package> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-single-c-file-package-hello-world> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-patching-code> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-fetching-code> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-post-installation-scripts> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#new-recipe-storing-and-naming-the-recipe> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#usingpoky-extend-customimage> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#finding-the-temporary-source-code> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#understand-what-gives-your-image-size> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#combining-multiple-versions-library-files-into-one-image> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#using-a-provided-kickstart-file> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#wic-using-the-wic-plugin-interface> > > FAILED _build/html/dev-manual/common-tasks.html <a > href=#wic-requirements> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#best-practices-to-follow-when-creating-layers> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#using-bbappend-files> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#incrementing-a-binary-package-version> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#automatically-incrementing-a-binary-package-revision-number> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#qemu-image-running-tests> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-debugging-viewing-logs-from-failed-tasks> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-debugging-viewing-variable-values> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-viewing-dependencies-between-recipes-and-tasks> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-viewing-task-variable-dependencies> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-debugging-taskrunning> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-debugging-bitbake> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-debugging-buildfile> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#platdev-gdb-remotedebug> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-other-debugging-others> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#dev-viewing-task-variable-dependencies> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#platdev-appdev-devshell> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#using-a-quilt-workflow> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#how-to-submit-a-change> > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#figuring-out-the-mailing-list-to-use> > > FAILED _build/html/dev-manual/qemu.html <a > > href=#qemu-running-under-a-network-file-system-nfs-server> > > FAILED _build/html/dev-manual/qemu.html <a href=#kvm-cond> > > FAILED _build/html/dev-manual/start.html <a href= > > https://autobuilder.yocto.io//pub/nightly/> > > FAILED _build/html/dev-manual/start.html <a href= > > https://autobuilder.yocto.io//pub/nightly/> > > FAILED _build/html/dev-manual/start.html <a > > href=#checkout-out-by-tag-in-poky> > > > > It's slow, it took 7 minutes to check for the dev-manual.. but it's a > first > > step. now we need to fix them! > > > > [1] https://github.com/jupyterlab/pytest-check-links > > > > In the end, I went for htmltest to test links: > https://github.com/wjdp/htmltest > > ~5min for the whole documentation. Not too bad :) > Very interesting... It took 6min the first time, and I found 271 errors in 145 documents. Then I applied your last patch, and it took 3 seconds, since it uses the local cache.. and found 190 errors. your patch looks nice too ;) We should review that a bit more, but looks like something we want to add in the AB, at least for the master-next builds.. > > Cheers, > Quentin > [-- Attachment #2: Type: text/html, Size: 8462 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-04-07 16:40 ` Nicolas Dechesne @ 2021-04-07 16:47 ` Quentin Schulz 2021-04-07 16:54 ` Nicolas Dechesne 0 siblings, 1 reply; 8+ messages in thread From: Quentin Schulz @ 2021-04-07 16:47 UTC (permalink / raw) To: Nicolas Dechesne; +Cc: YP docs mailing list, Robert Berger On Wed, Apr 07, 2021 at 06:40:32PM +0200, Nicolas Dechesne wrote: > On Wed, Apr 7, 2021 at 6:12 PM Quentin Schulz < > quentin.schulz@streamunlimited.com> wrote: > > > On Wed, Jan 13, 2021 at 07:26:17PM +0100, Nicolas Dechesne wrote: > > > On Thu, Jan 7, 2021 at 6:08 PM Nicolas Dechesne < > > nicolas.dechesne@linaro.org> > > > wrote: > > > > > > > > > > > > > > > On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < > > > > quentin.schulz@streamunlimited.com> wrote: > > > > > > > >> Hi Nicolas, > > > >> > > > >> On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > > > >> > hey! > > > >> > > > > >> > Robert opened a bug for a broken link in the doc, see > > > >> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > > > >> > > > > >> > This is a valid bug, a regression in > > > >> > e1bcfe4d8 dev-manual: remove unused labels > > > >> > > > > >> > Unfortunately, it opens a can of worms... since it looks like the > > built > > > >> in > > > >> > linkcheck did not detect the broken links, and this is not the only > > > >> broken > > > >> > link. > > > >> > > > > >> > I ran an online link checker on > > > >> > https://docs.yoctoproject.org/dev-manual/common-tasks.html, and it > > > >> reported > > > >> > the following errors with anchors.. they look like they are > > regression > > > >> with > > > >> > the commit above.. > > > >> > > > > >> > > > >> [...] > > > >> > > > >> It'd be nice to fix the linkcheck indeed. > > > >> > > > > > > > > hmm. could it be that linkcheck only checks for 'external' links? > > > > > > > > > > in the meantime I was looking for a tool I could run locally, and found > > [1] > > > > > > It looks like it gives some good output: > > > > > > $ pytest --check-links --check-anchors --check-links-cache > > > _build/html/dev-manual/ > > > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-autotooled-package> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-single-c-file-package-hello-world> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-patching-code> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-fetching-code> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-post-installation-scripts> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#new-recipe-storing-and-naming-the-recipe> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#usingpoky-extend-customimage> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#finding-the-temporary-source-code> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#understand-what-gives-your-image-size> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#combining-multiple-versions-library-files-into-one-image> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#using-a-provided-kickstart-file> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#wic-using-the-wic-plugin-interface> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > href=#wic-requirements> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#best-practices-to-follow-when-creating-layers> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#using-bbappend-files> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#incrementing-a-binary-package-version> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#automatically-incrementing-a-binary-package-revision-number> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#qemu-image-running-tests> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-debugging-viewing-logs-from-failed-tasks> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-debugging-viewing-variable-values> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-viewing-dependencies-between-recipes-and-tasks> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-viewing-task-variable-dependencies> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-debugging-taskrunning> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-debugging-bitbake> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-debugging-buildfile> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#platdev-gdb-remotedebug> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-other-debugging-others> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#dev-viewing-task-variable-dependencies> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#platdev-appdev-devshell> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#using-a-quilt-workflow> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#how-to-submit-a-change> > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#figuring-out-the-mailing-list-to-use> > > > FAILED _build/html/dev-manual/qemu.html <a > > > href=#qemu-running-under-a-network-file-system-nfs-server> > > > FAILED _build/html/dev-manual/qemu.html <a href=#kvm-cond> > > > FAILED _build/html/dev-manual/start.html <a href= > > > https://autobuilder.yocto.io//pub/nightly/> > > > FAILED _build/html/dev-manual/start.html <a href= > > > https://autobuilder.yocto.io//pub/nightly/> > > > FAILED _build/html/dev-manual/start.html <a > > > href=#checkout-out-by-tag-in-poky> > > > > > > It's slow, it took 7 minutes to check for the dev-manual.. but it's a > > first > > > step. now we need to fix them! > > > > > > [1] https://github.com/jupyterlab/pytest-check-links > > > > > > > In the end, I went for htmltest to test links: > > https://github.com/wjdp/htmltest > > > > ~5min for the whole documentation. Not too bad :) > > > > Very interesting... It took 6min the first time, and I found 271 errors in > 145 documents. Then I applied your last patch, and it took 3 seconds, since > it uses the local cache.. and found 190 errors. your patch looks nice too > ;) Well... I know what's next then :) > We should review that a bit more, but looks like something we want to add > in the AB, at least for the master-next builds.. > To be fair, I said in the patch that I removed anchor links only :p I didn't check other links (though htmltest returns two 502 for the AB links). Cheers, Quentin ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [docs] broken links 2021-04-07 16:47 ` Quentin Schulz @ 2021-04-07 16:54 ` Nicolas Dechesne 0 siblings, 0 replies; 8+ messages in thread From: Nicolas Dechesne @ 2021-04-07 16:54 UTC (permalink / raw) To: Quentin Schulz; +Cc: YP docs mailing list, Robert Berger [-- Attachment #1: Type: text/plain, Size: 7485 bytes --] On Wed, Apr 7, 2021 at 6:48 PM Quentin Schulz < quentin.schulz@streamunlimited.com> wrote: > On Wed, Apr 07, 2021 at 06:40:32PM +0200, Nicolas Dechesne wrote: > > On Wed, Apr 7, 2021 at 6:12 PM Quentin Schulz < > > quentin.schulz@streamunlimited.com> wrote: > > > > > On Wed, Jan 13, 2021 at 07:26:17PM +0100, Nicolas Dechesne wrote: > > > > On Thu, Jan 7, 2021 at 6:08 PM Nicolas Dechesne < > > > nicolas.dechesne@linaro.org> > > > > wrote: > > > > > > > > > > > > > > > > > > > On Thu, Jan 7, 2021 at 5:59 PM Quentin Schulz < > > > > > quentin.schulz@streamunlimited.com> wrote: > > > > > > > > > >> Hi Nicolas, > > > > >> > > > > >> On Thu, Jan 07, 2021 at 05:52:49PM +0100, Nicolas Dechesne wrote: > > > > >> > hey! > > > > >> > > > > > >> > Robert opened a bug for a broken link in the doc, see > > > > >> > https://bugzilla.yoctoproject.org/show_bug.cgi?id=14168 > > > > >> > > > > > >> > This is a valid bug, a regression in > > > > >> > e1bcfe4d8 dev-manual: remove unused labels > > > > >> > > > > > >> > Unfortunately, it opens a can of worms... since it looks like > the > > > built > > > > >> in > > > > >> > linkcheck did not detect the broken links, and this is not the > only > > > > >> broken > > > > >> > link. > > > > >> > > > > > >> > I ran an online link checker on > > > > >> > https://docs.yoctoproject.org/dev-manual/common-tasks.html, > and it > > > > >> reported > > > > >> > the following errors with anchors.. they look like they are > > > regression > > > > >> with > > > > >> > the commit above.. > > > > >> > > > > > >> > > > > >> [...] > > > > >> > > > > >> It'd be nice to fix the linkcheck indeed. > > > > >> > > > > > > > > > > hmm. could it be that linkcheck only checks for 'external' links? > > > > > > > > > > > > > in the meantime I was looking for a tool I could run locally, and > found > > > [1] > > > > > > > > It looks like it gives some good output: > > > > > > > > $ pytest --check-links --check-anchors --check-links-cache > > > > _build/html/dev-manual/ > > > > > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-autotooled-package> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-single-c-file-package-hello-world> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-patching-code> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-fetching-code> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-post-installation-scripts> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#new-recipe-storing-and-naming-the-recipe> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#usingpoky-extend-customimage> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#finding-the-temporary-source-code> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#understand-what-gives-your-image-size> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#combining-multiple-versions-library-files-into-one-image> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#using-a-provided-kickstart-file> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#wic-using-the-wic-plugin-interface> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > href=#wic-requirements> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#best-practices-to-follow-when-creating-layers> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#using-bbappend-files> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#incrementing-a-binary-package-version> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#automatically-incrementing-a-binary-package-revision-number> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#qemu-image-running-tests> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-debugging-viewing-logs-from-failed-tasks> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-debugging-viewing-variable-values> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-viewing-dependencies-between-recipes-and-tasks> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-viewing-task-variable-dependencies> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-debugging-taskrunning> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-debugging-bitbake> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-debugging-buildfile> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#platdev-gdb-remotedebug> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-other-debugging-others> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#dev-viewing-task-variable-dependencies> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#platdev-appdev-devshell> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#using-a-quilt-workflow> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#how-to-submit-a-change> > > > > FAILED _build/html/dev-manual/common-tasks.html <a > > > > href=#figuring-out-the-mailing-list-to-use> > > > > FAILED _build/html/dev-manual/qemu.html <a > > > > href=#qemu-running-under-a-network-file-system-nfs-server> > > > > FAILED _build/html/dev-manual/qemu.html <a href=#kvm-cond> > > > > FAILED _build/html/dev-manual/start.html <a href= > > > > https://autobuilder.yocto.io//pub/nightly/> > > > > FAILED _build/html/dev-manual/start.html <a href= > > > > https://autobuilder.yocto.io//pub/nightly/> > > > > FAILED _build/html/dev-manual/start.html <a > > > > href=#checkout-out-by-tag-in-poky> > > > > > > > > It's slow, it took 7 minutes to check for the dev-manual.. but it's a > > > first > > > > step. now we need to fix them! > > > > > > > > [1] https://github.com/jupyterlab/pytest-check-links > > > > > > > > > > In the end, I went for htmltest to test links: > > > https://github.com/wjdp/htmltest > > > > > > ~5min for the whole documentation. Not too bad :) > > > > > > > Very interesting... It took 6min the first time, and I found 271 errors > in > > 145 documents. Then I applied your last patch, and it took 3 seconds, > since > > it uses the local cache.. and found 190 errors. your patch looks nice too > > ;) > > Well... I know what's next then :) > > We should review that a bit more, but looks like something we want to add > > in the AB, at least for the master-next builds.. > > > > To be fair, I said in the patch that I removed anchor links only :p > > we could run in the AB without Failing at least for now. But just getting the logs for each build would be really nice. If we ever reach 0 , then we could start failing in the AB to flag issues! > I didn't check other links (though htmltest returns two 502 for the AB > links). > I really like that you can have a local config file (in the tree), so that anyone can run the same config.. this tool looks really quite good! thanks! > > Cheers, > Quentin > [-- Attachment #2: Type: text/html, Size: 11122 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2021-04-07 16:54 UTC | newest] Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2021-01-07 16:52 broken links Nicolas Dechesne 2021-01-07 16:59 ` [docs] " Quentin Schulz 2021-01-07 17:08 ` Nicolas Dechesne 2021-01-13 18:26 ` Nicolas Dechesne 2021-04-07 16:12 ` Quentin Schulz 2021-04-07 16:40 ` Nicolas Dechesne 2021-04-07 16:47 ` Quentin Schulz 2021-04-07 16:54 ` Nicolas Dechesne
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.