diff options
| author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-04-11 17:38:18 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-04-21 23:03:18 +0100 |
| commit | 392de9d5685e17aed868eb5659032103748825f4 (patch) | |
| tree | df0ea22b9719dbddb374aeb185ec9760eccd74bb | |
| parent | 982aa36251a4a855102575b8a590929787c645fd (diff) | |
| download | poky-392de9d5685e17aed868eb5659032103748825f4.tar.gz | |
bitbake: doc: Rename user-manual -> bitbake-user-manual
This manual gets combined with other manuals and in that context, it helps
a lot if its seen as the Bitbake User Manual. Renames are a pain but
this is worthwhile so that other docs can correctly be combined with this
one. This also clarifies things like google search results which is helpful.
(Bitbake rev: 452a62ae0c2793e281d6769fd3e45500a74898d6)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | bitbake/doc/Makefile | 14 | ||||
| -rw-r--r-- | bitbake/doc/README | 4 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-customization.xsl (renamed from bitbake/doc/user-manual/user-manual-customization.xsl) | 0 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml (renamed from bitbake/doc/user-manual/user-manual-execution.xml) | 4 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml (renamed from bitbake/doc/user-manual/user-manual-fetching.xml) | 0 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml (renamed from bitbake/doc/user-manual/user-manual-hello.xml) | 2 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml (renamed from bitbake/doc/user-manual/user-manual-intro.xml) | 4 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml (renamed from bitbake/doc/user-manual/user-manual-metadata.xml) | 2 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml (renamed from bitbake/doc/user-manual/user-manual-ref-variables.xml) | 0 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-style.css (renamed from bitbake/doc/user-manual/user-manual-style.css) | 0 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual.xml (renamed from bitbake/doc/user-manual/user-manual.xml) | 12 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/figures/bitbake-title.png (renamed from bitbake/doc/user-manual/figures/bitbake-title.png) | bin | 5086 -> 5086 bytes | |||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/html.css (renamed from bitbake/doc/user-manual/html.css) | 0 | ||||
| -rw-r--r-- | bitbake/doc/template/titlepage.templates.xml | 4 |
14 files changed, 23 insertions, 23 deletions
diff --git a/bitbake/doc/Makefile b/bitbake/doc/Makefile index 6b2af67326..8e98c57eb1 100644 --- a/bitbake/doc/Makefile +++ b/bitbake/doc/Makefile | |||
| @@ -18,21 +18,21 @@ | |||
| 18 | # | 18 | # |
| 19 | # Examples: | 19 | # Examples: |
| 20 | # | 20 | # |
| 21 | # make DOC=user-manual | 21 | # make DOC=bitbake-user-manual |
| 22 | # make pdf DOC=user-manual | 22 | # make pdf DOC=bitbake-user-manual |
| 23 | # | 23 | # |
| 24 | # The first example generates the HTML and PDF versions of the User Manual. | 24 | # The first example generates the HTML and PDF versions of the User Manual. |
| 25 | # The second example generates the HTML version only of the User Manual. | 25 | # The second example generates the HTML version only of the User Manual. |
| 26 | # | 26 | # |
| 27 | 27 | ||
| 28 | ifeq ($(DOC),user-manual) | 28 | ifeq ($(DOC),bitbake-user-manual) |
| 29 | XSLTOPTS = --stringparam html.stylesheet user-manual-style.css \ | 29 | XSLTOPTS = --stringparam html.stylesheet bitbake-user-manual-style.css \ |
| 30 | --stringparam chapter.autolabel 1 \ | 30 | --stringparam chapter.autolabel 1 \ |
| 31 | --stringparam section.autolabel 1 \ | 31 | --stringparam section.autolabel 1 \ |
| 32 | --stringparam section.label.includes.component.label 1 \ | 32 | --stringparam section.label.includes.component.label 1 \ |
| 33 | --xinclude | 33 | --xinclude |
| 34 | ALLPREQ = html pdf tarball | 34 | ALLPREQ = html pdf tarball |
| 35 | TARFILES = user-manual-style.css user-manual.html user-manual.pdf figures/bitbake-title.png | 35 | TARFILES = bitbake-user-manual-style.css bitbake-user-manual.html bitbake-user-manual.pdf figures/bitbake-title.png |
| 36 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf | 36 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf |
| 37 | FIGURES = figures | 37 | FIGURES = figures |
| 38 | STYLESHEET = $(DOC)/*.css | 38 | STYLESHEET = $(DOC)/*.css |
| @@ -48,7 +48,7 @@ XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl | |||
| 48 | all: $(ALLPREQ) | 48 | all: $(ALLPREQ) |
| 49 | 49 | ||
| 50 | pdf: | 50 | pdf: |
| 51 | ifeq ($(DOC),user-manual) | 51 | ifeq ($(DOC),bitbake-user-manual) |
| 52 | @echo " " | 52 | @echo " " |
| 53 | @echo "********** Building."$(DOC) | 53 | @echo "********** Building."$(DOC) |
| 54 | @echo " " | 54 | @echo " " |
| @@ -56,7 +56,7 @@ ifeq ($(DOC),user-manual) | |||
| 56 | endif | 56 | endif |
| 57 | 57 | ||
| 58 | html: | 58 | html: |
| 59 | ifeq ($(DOC),user-manual) | 59 | ifeq ($(DOC),bitbake-user-manual) |
| 60 | # See http://www.sagehill.net/docbookxsl/HtmlOutput.html | 60 | # See http://www.sagehill.net/docbookxsl/HtmlOutput.html |
| 61 | @echo " " | 61 | @echo " " |
| 62 | @echo "******** Building "$(DOC) | 62 | @echo "******** Building "$(DOC) |
diff --git a/bitbake/doc/README b/bitbake/doc/README index 90aafea9cb..303cf8eec7 100644 --- a/bitbake/doc/README +++ b/bitbake/doc/README | |||
| @@ -8,7 +8,7 @@ Manual Organization | |||
| 8 | 8 | ||
| 9 | Folders exist for individual manuals as follows: | 9 | Folders exist for individual manuals as follows: |
| 10 | 10 | ||
| 11 | * user-manual - The BitBake User Manual | 11 | * bitbake-user-manual - The BitBake User Manual |
| 12 | 12 | ||
| 13 | Each folder is self-contained regarding content and figures. | 13 | Each folder is self-contained regarding content and figures. |
| 14 | 14 | ||
| @@ -28,7 +28,7 @@ For example, the following command run from the documentation directory | |||
| 28 | creates an HTML and a PDF version of the BitBake User Manual. | 28 | creates an HTML and a PDF version of the BitBake User Manual. |
| 29 | The DOC variable specifies the manual you are making: | 29 | The DOC variable specifies the manual you are making: |
| 30 | 30 | ||
| 31 | $ make DOC=user-manual | 31 | $ make DOC=bitbake-user-manual |
| 32 | 32 | ||
| 33 | template | 33 | template |
| 34 | ======== | 34 | ======== |
diff --git a/bitbake/doc/user-manual/user-manual-customization.xsl b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-customization.xsl index a8ec28ae20..a8ec28ae20 100644 --- a/bitbake/doc/user-manual/user-manual-customization.xsl +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-customization.xsl | |||
diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml index 1cb7fc63ce..8514f23f25 100644 --- a/bitbake/doc/user-manual/user-manual-execution.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 3 | 3 | ||
| 4 | <chapter id="user-manual-execution"> | 4 | <chapter id="bitbake-user-manual-execution"> |
| 5 | <title>Execution</title> | 5 | <title>Execution</title> |
| 6 | 6 | ||
| 7 | <para> | 7 | <para> |
| @@ -24,7 +24,7 @@ | |||
| 24 | </literallayout> | 24 | </literallayout> |
| 25 | For information on the BitBake command and its options, | 25 | For information on the BitBake command and its options, |
| 26 | see | 26 | see |
| 27 | "<link linkend='user-manual-command'>The BitBake Command</link>" | 27 | "<link linkend='bitbake-user-manual-command'>The BitBake Command</link>" |
| 28 | section. | 28 | section. |
| 29 | </para> | 29 | </para> |
| 30 | 30 | ||
diff --git a/bitbake/doc/user-manual/user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 5aa53defc4..5aa53defc4 100644 --- a/bitbake/doc/user-manual/user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml | |||
diff --git a/bitbake/doc/user-manual/user-manual-hello.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml index 5a616e07b3..3215e49a28 100644 --- a/bitbake/doc/user-manual/user-manual-hello.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml | |||
| @@ -130,7 +130,7 @@ | |||
| 130 | While every attempt is made to explain what is happening, | 130 | While every attempt is made to explain what is happening, |
| 131 | not everything can be covered. | 131 | not everything can be covered. |
| 132 | You can find further information in the | 132 | You can find further information in the |
| 133 | "<link linkend='user-manual-metadata'>Syntax and Operators</link>" | 133 | "<link linkend='bitbake-user-manual-metadata'>Syntax and Operators</link>" |
| 134 | chapter. | 134 | chapter. |
| 135 | </para> | 135 | </para> |
| 136 | 136 | ||
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml index cd05fc5d07..ae267b42c8 100644 --- a/bitbake/doc/user-manual/user-manual-intro.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 3 | 3 | ||
| 4 | <chapter id="user-manual-intro"> | 4 | <chapter id="bitbake-user-manual-intro"> |
| 5 | <title>Overview</title> | 5 | <title>Overview</title> |
| 6 | 6 | ||
| 7 | <para> | 7 | <para> |
| @@ -417,7 +417,7 @@ | |||
| 417 | </para> | 417 | </para> |
| 418 | </section> | 418 | </section> |
| 419 | 419 | ||
| 420 | <section id="user-manual-command"> | 420 | <section id="bitbake-user-manual-command"> |
| 421 | <title>The BitBake Command</title> | 421 | <title>The BitBake Command</title> |
| 422 | 422 | ||
| 423 | <para> | 423 | <para> |
diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml index a57fe0c814..41ae3b8c0a 100644 --- a/bitbake/doc/user-manual/user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 3 | 3 | ||
| 4 | <chapter id="user-manual-metadata"> | 4 | <chapter id="bitbake-user-manual-metadata"> |
| 5 | <title>Syntax and Operators</title> | 5 | <title>Syntax and Operators</title> |
| 6 | 6 | ||
| 7 | <para> | 7 | <para> |
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml index 6a5af89ffa..6a5af89ffa 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml | |||
diff --git a/bitbake/doc/user-manual/user-manual-style.css b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-style.css index f7e95f76bf..f7e95f76bf 100644 --- a/bitbake/doc/user-manual/user-manual-style.css +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-style.css | |||
diff --git a/bitbake/doc/user-manual/user-manual.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual.xml index 9f94886c7f..e927c4d9e3 100644 --- a/bitbake/doc/user-manual/user-manual.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual.xml | |||
| @@ -73,16 +73,16 @@ | |||
| 73 | </legalnotice> | 73 | </legalnotice> |
| 74 | </bookinfo> | 74 | </bookinfo> |
| 75 | 75 | ||
| 76 | <xi:include href="user-manual-intro.xml"/> | 76 | <xi:include href="bitbake-user-manual-intro.xml"/> |
| 77 | 77 | ||
| 78 | <xi:include href="user-manual-execution.xml"/> | 78 | <xi:include href="bitbake-user-manual-execution.xml"/> |
| 79 | 79 | ||
| 80 | <xi:include href="user-manual-metadata.xml"/> | 80 | <xi:include href="bitbake-user-manual-metadata.xml"/> |
| 81 | 81 | ||
| 82 | <xi:include href="user-manual-fetching.xml"/> | 82 | <xi:include href="bitbake-user-manual-fetching.xml"/> |
| 83 | 83 | ||
| 84 | <xi:include href="user-manual-ref-variables.xml"/> | 84 | <xi:include href="bitbake-user-manual-ref-variables.xml"/> |
| 85 | 85 | ||
| 86 | <xi:include href="user-manual-hello.xml"/> | 86 | <xi:include href="bitbake-user-manual-hello.xml"/> |
| 87 | 87 | ||
| 88 | </book> | 88 | </book> |
diff --git a/bitbake/doc/user-manual/figures/bitbake-title.png b/bitbake/doc/bitbake-user-manual/figures/bitbake-title.png index cb290154da..cb290154da 100644 --- a/bitbake/doc/user-manual/figures/bitbake-title.png +++ b/bitbake/doc/bitbake-user-manual/figures/bitbake-title.png | |||
| Binary files differ | |||
diff --git a/bitbake/doc/user-manual/html.css b/bitbake/doc/bitbake-user-manual/html.css index 6eedfd3189..6eedfd3189 100644 --- a/bitbake/doc/user-manual/html.css +++ b/bitbake/doc/bitbake-user-manual/html.css | |||
diff --git a/bitbake/doc/template/titlepage.templates.xml b/bitbake/doc/template/titlepage.templates.xml index 6906604db6..38ec11a4c3 100644 --- a/bitbake/doc/template/titlepage.templates.xml +++ b/bitbake/doc/template/titlepage.templates.xml | |||
| @@ -144,7 +144,7 @@ | |||
| 144 | 144 | ||
| 145 | # If you leave this block of code in then the text title in the | 145 | # If you leave this block of code in then the text title in the |
| 146 | # <title>BitBake User Manual</title> statement of the | 146 | # <title>BitBake User Manual</title> statement of the |
| 147 | # user-manual.xml file is rendered on the title page below the | 147 | # bitbake-user-manual.xml file is rendered on the title page below the |
| 148 | # image. Commenting it out gets it out of there yet allows it | 148 | # image. Commenting it out gets it out of there yet allows it |
| 149 | # to be retained in the tab text for the HTML version of the | 149 | # to be retained in the tab text for the HTML version of the |
| 150 | # manual. | 150 | # manual. |
| @@ -176,7 +176,7 @@ | |||
| 176 | <!-- | 176 | <!-- |
| 177 | # If you leave this block of code in then the text title in the | 177 | # If you leave this block of code in then the text title in the |
| 178 | # <title>BitBake User Manual</title> statement of the | 178 | # <title>BitBake User Manual</title> statement of the |
| 179 | # user-manual.xml file is rendered on the title page below the | 179 | # bitbake-user-manual.xml file is rendered on the title page below the |
| 180 | # image. Commenting it out gets it out of there yet allows it | 180 | # image. Commenting it out gets it out of there yet allows it |
| 181 | # to be retained in the tab text for the HTML version of the | 181 | # to be retained in the tab text for the HTML version of the |
| 182 | # manual. | 182 | # manual. |
