Files
poky/documentation/tools/mega-manual.sed
Scott Rifenbark 3a8b4648d4 mega-manual.sed: Added overview manual and extra subst.
Updated the script to process the overview-manual strings
found in the mega-manual.  These changed due to the folder
chaning from "getting-started" to "overview-manual".

Additionally, I discovered a single occurrence of a linked
reference to the mega-manual that was in the mega-manual.
This is not ideal.  That link needs to be a link in the
ref-manual where it originates.  However, the link in the
mega-manual should not link to itself.  That link needed
processing just like all top-level book links in the
mega-manual.  The link should be removed.  I added a single
substitution operation at the end of the file to handle this
lone case within the mega-manual.

(From yocto-docs rev: 57ebdb1cb10a4df0d69316d1f116d7804199ae90)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:47 +01:00

41 lines
4.4 KiB
Sed

# Processes poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style).
# This style is for manual folders like "yocto-project-qs" and "poky-ref-manual".
# This is the old way that did it. Can't do that now that we have "bitbake-user-manual" strings
# in the mega-manual.
# s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/[a-z]*-[a-z]*-[a-z]*\/[a-z]*-[a-z]*-[a-z]*.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/yocto-project-qs.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/poky-ref-manual\/poky-ref-manual.html#/"link" href="#/g
# Processes all other manuals (<word>-<word> style) except for the BitBake User Manual because
# it is not included in the mega-manual.
# This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual").
# This was the one-liner that worked before we introduced the BitBake User Manual, which is
# not in the mega-manual.
# s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/[a-z]*-[a-z]*\/[a-z]*-[a-z]*.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/overview-manual\/overview-manual.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/brief-yoctoprojectqs\/brief-yoctoprojectqs.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/kernel-dev\/kernel-dev.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/ref-manual\/ref-manual.html#/"link" href="#/g
s/"ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/toaster-manual\/toaster-manual.html#/"link" href="#/g
# Process cases where just an external manual is referenced without an id anchor
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/brief-yoctoprojectqs\/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build<\/a>/Yocto Project Quick Build/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/yocto-project-qs.html" target="_top">Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html" target="_top">Yocto Project Development Tasks Manual<\/a>/Yocto Project Development Tasks Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/overview-manual\/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual<\/a>/Yocto project Overview and Concepts Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)<\/a>/Yocto Project Application Development and the Extensible Software Development Kit (eSDK)/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html" target="_top">Yocto Project Profiling and Tracing Manual<\/a>/Yocto Project Profiling and Tracing Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/kernel-dev\/kernel-dev.html" target="_top">Yocto Project Linux Kernel Development Manual<\/a>/Yocto Project Linux Kernel Development Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/ref-manual\/ref-manual.html" target="_top">Yocto Project Reference Manual<\/a>/Yocto Project Reference Manual/g
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/toaster-manual\/toaster-manual.html" target="_top">Toaster User Manual<\/a>/Toaster User Manual/g
# Process a single, rouge occurrence of a linked reference to the Mega-Manual.
s/<a class="ulink" href="http:\/\/www.yoctoproject.org\/docs\/2.5\/mega-manual\/mega-manual.html" target="_top">Yocto Project Mega-Manual<\/a>/Yocto Project Mega-Manual/g