[0/2] Documentation/linkcheck fixes
mbox series

Message ID 20250725172130.2218836-1-kieran.bingham@ideasonboard.com
Headers show
Series
  • Documentation/linkcheck fixes
Related show

Message

Kieran Bingham July 25, 2025, 5:21 p.m. UTC 
The doxygen build contains a tool to verify links are still valid.

Running this tool presently reports several issues fixed by this series.

You can run it too with:

  ninja -C build/gcc/ Documentation/linkcheck

And I've started an update to the CI to introduce including this -
however we can't merge that yet - because one of the documents is harder
to fix than the others.

Documentation/guides/tracing.rst references
https://lttng.org/docs/#doc-tracing-your-own-user-application and
https://lttng.org/docs/#doc-viewing-and-analyzing-your-traces-bt which
seem to be valid URL anchors in a web browser but the tooling reports
them as invalid. I suspect they may be generated after page load with
javascript or such that the tooling does not comprehend.

Anyway, perhaps the fixes to pipeline handler and application guides are
still worth merging first.


Kieran Bingham (2):
  Documentation: pipeline-handler: Fix broken links
  Documentation: application: Update mediactl URL

 Documentation/guides/application-developer.rst |  2 +-
 Documentation/guides/pipeline-handler.rst      | 12 ++++++------
 2 files changed, 7 insertions(+), 7 deletions(-)