diff options
Diffstat (limited to 'documentation/tools')
| -rw-r--r-- | documentation/tools/eclipse-help.sed | 3 | ||||
| -rw-r--r-- | documentation/tools/mega-manual.sed | 49 | ||||
| -rwxr-xr-x | documentation/tools/poky-docbook-to-pdf | 5 | ||||
| -rw-r--r-- | documentation/tools/update-documentation-conf | 16 |
4 files changed, 36 insertions, 37 deletions
diff --git a/documentation/tools/eclipse-help.sed b/documentation/tools/eclipse-help.sed index ab5c9affd4..9716ea42bc 100644 --- a/documentation/tools/eclipse-help.sed +++ b/documentation/tools/eclipse-help.sed | |||
| @@ -1,3 +1,6 @@ | |||
| 1 | # | ||
| 2 | # SPDX-License-Identifier: CC-BY-2.0-UK | ||
| 3 | # | ||
| 1 | # Process poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style) | 4 | # Process poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style) |
| 2 | # For example: | 5 | # For example: |
| 3 | # "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq" | 6 | # "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq" |
diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed index 12e0e6145b..c525ab46a4 100644 --- a/documentation/tools/mega-manual.sed +++ b/documentation/tools/mega-manual.sed | |||
| @@ -1,36 +1,39 @@ | |||
| 1 | # | ||
| 2 | # SPDX-License-Identifier: CC-BY-2.0-UK | ||
| 3 | # | ||
| 1 | # Processes bitbake-user-manual (<word>-<word>-<word> style). | 4 | # Processes bitbake-user-manual (<word>-<word>-<word> style). |
| 2 | # This style is for manual three-word folders, which currently is only the BitBake User Manual. | 5 | # This style is for manual three-word folders, which currently is only the BitBake User Manual. |
| 3 | # We used to have the "yocto-project-qs" and "poky-ref-manual" folders but no longer do. | 6 | # We used to have the "yocto-project-qs" and "poky-ref-manual" folders but no longer do. |
| 4 | # s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/[a-z]*-[a-z]*-[a-z]*/[a-z]*-[a-z]*-[a-z]*.html#@"link" href="#@g | 7 | # s@"ulink" href="http://www.yoctoproject.org/docs/3.1/[a-z]*-[a-z]*-[a-z]*/[a-z]*-[a-z]*-[a-z]*.html#@"link" href="#@g |
| 5 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g | 8 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/bitbake-user-manual/bitbake-user-manual.html#@"link" href="#@g |
| 6 | 9 | ||
| 7 | # Processes all other manuals (<word>-<word> style). | 10 | # Processes all other manuals (<word>-<word> style). |
| 8 | # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual"). | 11 | # This style is for manual folders that use two word, which is the standard now (e.g. "ref-manual"). |
| 9 | # Here is the one-liner: | 12 | # Here is the one-liner: |
| 10 | # s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g | 13 | # s@"ulink" href="http://www.yoctoproject.org/docs/3.1/[a-z]*-[a-z]*/[a-z]*-[a-z]*.html#@"link" href="#@g |
| 11 | 14 | ||
| 12 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/sdk-manual/sdk-manual.html#@"link" href="#@g | 15 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/sdk-manual/sdk-manual.html#@"link" href="#@g |
| 13 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/bsp-guide/bsp-guide.html#@"link" href="#@g | 16 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/bsp-guide/bsp-guide.html#@"link" href="#@g |
| 14 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#@"link" href="#@g | 17 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/dev-manual/dev-manual.html#@"link" href="#@g |
| 15 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/overview-manual/overview-manual.html#@"link" href="#@g | 18 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/overview-manual/overview-manual.html#@"link" href="#@g |
| 16 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/brief-yoctoprojectqs/brief-yoctoprojectqs.html#@"link" href="#@g | 19 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/brief-yoctoprojectqs/brief-yoctoprojectqs.html#@"link" href="#@g |
| 17 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/kernel-dev/kernel-dev.html#@"link" href="#@g | 20 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/kernel-dev/kernel-dev.html#@"link" href="#@g |
| 18 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/profile-manual/profile-manual.html#@"link" href="#@g | 21 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/profile-manual/profile-manual.html#@"link" href="#@g |
| 19 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#@"link" href="#@g | 22 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/ref-manual/ref-manual.html#@"link" href="#@g |
| 20 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1.4/toaster-manual/toaster-manual.html#@"link" href="#@g | 23 | s@"ulink" href="http://www.yoctoproject.org/docs/3.1/toaster-manual/toaster-manual.html#@"link" href="#@g |
| 21 | 24 | ||
| 22 | # Process cases where just an external manual is referenced without an id anchor | 25 | # Process cases where just an external manual is referenced without an id anchor |
| 23 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/brief-yoctoprojectqs/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build</a>@Yocto Project Quick Build@g | 26 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/brief-yoctoprojectqs/brief-yoctoprojectqs.html" target="_top">Yocto Project Quick Build</a>@Yocto Project Quick Build@g |
| 24 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/bitbake-user-manual/bitbake-user-manual.html" target="_top">BitBake User Manual</a>@BitBake User Manual@g | 27 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/bitbake-user-manual/bitbake-user-manual.html" target="_top">BitBake User Manual</a>@BitBake User Manual@g |
| 25 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>@Yocto Project Development Tasks Manual@g | 28 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>@Yocto Project Development Tasks Manual@g |
| 26 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/overview-manual/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual</a>@Yocto project Overview and Concepts Manual@g | 29 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/overview-manual/overview-manual.html" target="_top">Yocto Project Overview and Concepts Manual</a>@Yocto project Overview and Concepts Manual@g |
| 27 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/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 | 30 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/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 |
| 28 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/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 | 31 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/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 |
| 29 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/profile-manual/profile-manual.html" target="_top">Yocto Project Profiling and Tracing Manual</a>@Yocto Project Profiling and Tracing Manual@g | 32 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/profile-manual/profile-manual.html" target="_top">Yocto Project Profiling and Tracing Manual</a>@Yocto Project Profiling and Tracing Manual@g |
| 30 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/kernel-dev/kernel-dev.html" target="_top">Yocto Project Linux Kernel Development Manual</a>@Yocto Project Linux Kernel Development Manual@g | 33 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/kernel-dev/kernel-dev.html" target="_top">Yocto Project Linux Kernel Development Manual</a>@Yocto Project Linux Kernel Development Manual@g |
| 31 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>@Yocto Project Reference Manual@g | 34 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>@Yocto Project Reference Manual@g |
| 32 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/toaster-manual/toaster-manual.html" target="_top">Toaster User Manual</a>@Toaster User Manual@g | 35 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/toaster-manual/toaster-manual.html" target="_top">Toaster User Manual</a>@Toaster User Manual@g |
| 33 | 36 | ||
| 34 | # Process a single, rouge occurrence of a linked reference to the Mega-Manual. | 37 | # Process a single, rouge occurrence of a linked reference to the Mega-Manual. |
| 35 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1.4/mega-manual/mega-manual.html" target="_top">Yocto Project Mega-Manual</a>@Yocto Project Mega-Manual@g | 38 | s@<a class="ulink" href="http://www.yoctoproject.org/docs/3.1/mega-manual/mega-manual.html" target="_top">Yocto Project Mega-Manual</a>@Yocto Project Mega-Manual@g |
| 36 | 39 | ||
diff --git a/documentation/tools/poky-docbook-to-pdf b/documentation/tools/poky-docbook-to-pdf index f55fd278af..b36e74b6be 100755 --- a/documentation/tools/poky-docbook-to-pdf +++ b/documentation/tools/poky-docbook-to-pdf | |||
| @@ -1,5 +1,8 @@ | |||
| 1 | #!/bin/sh | 1 | #!/bin/sh |
| 2 | 2 | # | |
| 3 | # SPDX-License-Identifier: CC-BY-2.0-UK | ||
| 4 | # | ||
| 5 | |||
| 3 | if [ -z "$1" -o -z "$2" ]; then | 6 | if [ -z "$1" -o -z "$2" ]; then |
| 4 | echo "usage: [-v] $0 <docbook file> <templatedir>" | 7 | echo "usage: [-v] $0 <docbook file> <templatedir>" |
| 5 | echo | 8 | echo |
diff --git a/documentation/tools/update-documentation-conf b/documentation/tools/update-documentation-conf index 3f8d280093..adfca3ca50 100644 --- a/documentation/tools/update-documentation-conf +++ b/documentation/tools/update-documentation-conf | |||
| @@ -1,23 +1,13 @@ | |||
| 1 | #!/usr/bin/env python | 1 | #!/usr/bin/env python |
| 2 | 2 | # | |
| 3 | # SPDX-License-Identifier: GPL-2.0-only | ||
| 4 | # | ||
| 3 | # documentation.conf update script | 5 | # documentation.conf update script |
| 4 | # | 6 | # |
| 5 | # Author: Paul Eggleton <paul.eggleton@linux.intel.com> | 7 | # Author: Paul Eggleton <paul.eggleton@linux.intel.com> |
| 6 | # | 8 | # |
| 7 | # Copyright (C) 2015 Intel Corporation | 9 | # Copyright (C) 2015 Intel Corporation |
| 8 | # | 10 | # |
| 9 | # This program is free software; you can redistribute it and/or modify | ||
| 10 | # it under the terms of the GNU General Public License version 2 as | ||
| 11 | # published by the Free Software Foundation. | ||
| 12 | # | ||
| 13 | # This program is distributed in the hope that it will be useful, | ||
| 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 16 | # GNU General Public License for more details. | ||
| 17 | # | ||
| 18 | # You should have received a copy of the GNU General Public License along | ||
| 19 | # with this program; if not, write to the Free Software Foundation, Inc., | ||
| 20 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||
| 21 | 11 | ||
| 22 | 12 | ||
| 23 | import sys | 13 | import sys |