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>
This commit is contained in:
parent
982aa36251
commit
392de9d568
|
@ -18,21 +18,21 @@
|
||||||
#
|
#
|
||||||
# Examples:
|
# Examples:
|
||||||
#
|
#
|
||||||
# make DOC=user-manual
|
# make DOC=bitbake-user-manual
|
||||||
# make pdf DOC=user-manual
|
# make pdf DOC=bitbake-user-manual
|
||||||
#
|
#
|
||||||
# The first example generates the HTML and PDF versions of the User Manual.
|
# The first example generates the HTML and PDF versions of the User Manual.
|
||||||
# The second example generates the HTML version only of the User Manual.
|
# The second example generates the HTML version only of the User Manual.
|
||||||
#
|
#
|
||||||
|
|
||||||
ifeq ($(DOC),user-manual)
|
ifeq ($(DOC),bitbake-user-manual)
|
||||||
XSLTOPTS = --stringparam html.stylesheet user-manual-style.css \
|
XSLTOPTS = --stringparam html.stylesheet bitbake-user-manual-style.css \
|
||||||
--stringparam chapter.autolabel 1 \
|
--stringparam chapter.autolabel 1 \
|
||||||
--stringparam section.autolabel 1 \
|
--stringparam section.autolabel 1 \
|
||||||
--stringparam section.label.includes.component.label 1 \
|
--stringparam section.label.includes.component.label 1 \
|
||||||
--xinclude
|
--xinclude
|
||||||
ALLPREQ = html pdf tarball
|
ALLPREQ = html pdf tarball
|
||||||
TARFILES = user-manual-style.css user-manual.html user-manual.pdf figures/bitbake-title.png
|
TARFILES = bitbake-user-manual-style.css bitbake-user-manual.html bitbake-user-manual.pdf figures/bitbake-title.png
|
||||||
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
|
||||||
FIGURES = figures
|
FIGURES = figures
|
||||||
STYLESHEET = $(DOC)/*.css
|
STYLESHEET = $(DOC)/*.css
|
||||||
|
@ -48,7 +48,7 @@ XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
|
||||||
all: $(ALLPREQ)
|
all: $(ALLPREQ)
|
||||||
|
|
||||||
pdf:
|
pdf:
|
||||||
ifeq ($(DOC),user-manual)
|
ifeq ($(DOC),bitbake-user-manual)
|
||||||
@echo " "
|
@echo " "
|
||||||
@echo "********** Building."$(DOC)
|
@echo "********** Building."$(DOC)
|
||||||
@echo " "
|
@echo " "
|
||||||
|
@ -56,7 +56,7 @@ ifeq ($(DOC),user-manual)
|
||||||
endif
|
endif
|
||||||
|
|
||||||
html:
|
html:
|
||||||
ifeq ($(DOC),user-manual)
|
ifeq ($(DOC),bitbake-user-manual)
|
||||||
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
|
# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
|
||||||
@echo " "
|
@echo " "
|
||||||
@echo "******** Building "$(DOC)
|
@echo "******** Building "$(DOC)
|
||||||
|
|
|
@ -8,7 +8,7 @@ Manual Organization
|
||||||
|
|
||||||
Folders exist for individual manuals as follows:
|
Folders exist for individual manuals as follows:
|
||||||
|
|
||||||
* user-manual - The BitBake User Manual
|
* bitbake-user-manual - The BitBake User Manual
|
||||||
|
|
||||||
Each folder is self-contained regarding content and figures.
|
Each folder is self-contained regarding content and figures.
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ For example, the following command run from the documentation directory
|
||||||
creates an HTML and a PDF version of the BitBake User Manual.
|
creates an HTML and a PDF version of the BitBake User Manual.
|
||||||
The DOC variable specifies the manual you are making:
|
The DOC variable specifies the manual you are making:
|
||||||
|
|
||||||
$ make DOC=user-manual
|
$ make DOC=bitbake-user-manual
|
||||||
|
|
||||||
template
|
template
|
||||||
========
|
========
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||||
|
|
||||||
<chapter id="user-manual-execution">
|
<chapter id="bitbake-user-manual-execution">
|
||||||
<title>Execution</title>
|
<title>Execution</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -24,7 +24,7 @@
|
||||||
</literallayout>
|
</literallayout>
|
||||||
For information on the BitBake command and its options,
|
For information on the BitBake command and its options,
|
||||||
see
|
see
|
||||||
"<link linkend='user-manual-command'>The BitBake Command</link>"
|
"<link linkend='bitbake-user-manual-command'>The BitBake Command</link>"
|
||||||
section.
|
section.
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -130,7 +130,7 @@
|
||||||
While every attempt is made to explain what is happening,
|
While every attempt is made to explain what is happening,
|
||||||
not everything can be covered.
|
not everything can be covered.
|
||||||
You can find further information in the
|
You can find further information in the
|
||||||
"<link linkend='user-manual-metadata'>Syntax and Operators</link>"
|
"<link linkend='bitbake-user-manual-metadata'>Syntax and Operators</link>"
|
||||||
chapter.
|
chapter.
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||||
|
|
||||||
<chapter id="user-manual-intro">
|
<chapter id="bitbake-user-manual-intro">
|
||||||
<title>Overview</title>
|
<title>Overview</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -417,7 +417,7 @@
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="user-manual-command">
|
<section id="bitbake-user-manual-command">
|
||||||
<title>The BitBake Command</title>
|
<title>The BitBake Command</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||||
|
|
||||||
<chapter id="user-manual-metadata">
|
<chapter id="bitbake-user-manual-metadata">
|
||||||
<title>Syntax and Operators</title>
|
<title>Syntax and Operators</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
|
@ -73,16 +73,16 @@
|
||||||
</legalnotice>
|
</legalnotice>
|
||||||
</bookinfo>
|
</bookinfo>
|
||||||
|
|
||||||
<xi:include href="user-manual-intro.xml"/>
|
<xi:include href="bitbake-user-manual-intro.xml"/>
|
||||||
|
|
||||||
<xi:include href="user-manual-execution.xml"/>
|
<xi:include href="bitbake-user-manual-execution.xml"/>
|
||||||
|
|
||||||
<xi:include href="user-manual-metadata.xml"/>
|
<xi:include href="bitbake-user-manual-metadata.xml"/>
|
||||||
|
|
||||||
<xi:include href="user-manual-fetching.xml"/>
|
<xi:include href="bitbake-user-manual-fetching.xml"/>
|
||||||
|
|
||||||
<xi:include href="user-manual-ref-variables.xml"/>
|
<xi:include href="bitbake-user-manual-ref-variables.xml"/>
|
||||||
|
|
||||||
<xi:include href="user-manual-hello.xml"/>
|
<xi:include href="bitbake-user-manual-hello.xml"/>
|
||||||
|
|
||||||
</book>
|
</book>
|
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
|
@ -144,7 +144,7 @@
|
||||||
|
|
||||||
# If you leave this block of code in then the text title in the
|
# If you leave this block of code in then the text title in the
|
||||||
# <title>BitBake User Manual</title> statement of the
|
# <title>BitBake User Manual</title> statement of the
|
||||||
# user-manual.xml file is rendered on the title page below the
|
# bitbake-user-manual.xml file is rendered on the title page below the
|
||||||
# image. Commenting it out gets it out of there yet allows it
|
# image. Commenting it out gets it out of there yet allows it
|
||||||
# to be retained in the tab text for the HTML version of the
|
# to be retained in the tab text for the HTML version of the
|
||||||
# manual.
|
# manual.
|
||||||
|
@ -176,7 +176,7 @@
|
||||||
<!--
|
<!--
|
||||||
# If you leave this block of code in then the text title in the
|
# If you leave this block of code in then the text title in the
|
||||||
# <title>BitBake User Manual</title> statement of the
|
# <title>BitBake User Manual</title> statement of the
|
||||||
# user-manual.xml file is rendered on the title page below the
|
# bitbake-user-manual.xml file is rendered on the title page below the
|
||||||
# image. Commenting it out gets it out of there yet allows it
|
# image. Commenting it out gets it out of there yet allows it
|
||||||
# to be retained in the tab text for the HTML version of the
|
# to be retained in the tab text for the HTML version of the
|
||||||
# manual.
|
# manual.
|
||||||
|
|
Loading…
Reference in New Issue