summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 16:18:27 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-16 18:14:07 +0100
commit2df3190f13b23c8423adf907e8ce025d04b3f781 (patch)
tree948b0ab64c521d540db82ff077371bdaf4f79713 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
parent623ea7f3fe9fe8c972b5c6c3bcbe6fc0c4798182 (diff)
downloadpoky-2df3190f13b23c8423adf907e8ce025d04b3f781.tar.gz
bitbake: sphinx: fixup for links
Since we converted the list of variables into a Sphinx glossary, the automatic conversion from Pandoc does not produce proper links. We fix them up using a Python regexp. Similarly some http links were not converted correctly, and can also be fixed up with a regexp. This patch was generated by running the following regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) line = re.sub("`+(\w+)`* <#var-bb-\\1>`__", ":term:`\\1`", line) (Bitbake rev: 57300955beb200c81762880f44f1a499451b7432) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
index 174c797ae1..32d5b7bbcc 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
@@ -73,7 +73,7 @@ While every attempt is made to explain what is happening during the
73example, the descriptions cannot cover everything. You can find further 73example, the descriptions cannot cover everything. You can find further
74information throughout this manual. Also, you can actively participate 74information throughout this manual. Also, you can actively participate
75in the 75in the
76` <http://lists.openembedded.org/mailman/listinfo/bitbake-devel>`__ 76http://lists.openembedded.org/mailman/listinfo/bitbake-devel
77discussion mailing list about the BitBake build tool. 77discussion mailing list about the BitBake build tool.
78 78
79.. note:: 79.. note::
@@ -120,7 +120,7 @@ Following is the complete "Hello World" example.
120 ``conf/bblayers.conf`` file is relevant. 120 ``conf/bblayers.conf`` file is relevant.
121 121
122 When you run BitBake, it begins looking for metadata files. The 122 When you run BitBake, it begins looking for metadata files. The
123 ```BBPATH`` <#var-bb-BBPATH>`__ variable is what tells BitBake where 123 :term:`BBPATH` variable is what tells BitBake where
124 to look for those files. ``BBPATH`` is not set and you need to set 124 to look for those files. ``BBPATH`` is not set and you need to set
125 it. Without ``BBPATH``, BitBake cannot find any configuration files 125 it. Without ``BBPATH``, BitBake cannot find any configuration files
126 (``.conf``) or recipe files (``.bb``) at all. BitBake also cannot 126 (``.conf``) or recipe files (``.bb``) at all. BitBake also cannot
@@ -168,17 +168,17 @@ Following is the complete "Hello World" example.
168 recipe files. For this example, you need to create the file in your 168 recipe files. For this example, you need to create the file in your
169 project directory and define some key BitBake variables. For more 169 project directory and define some key BitBake variables. For more
170 information on the ``bitbake.conf`` file, see 170 information on the ``bitbake.conf`` file, see
171 ` <http://git.openembedded.org/bitbake/tree/conf/bitbake.conf>`__. 171 http://git.openembedded.org/bitbake/tree/conf/bitbake.conf.
172 172
173 Use the following commands to create the ``conf`` directory in the 173 Use the following commands to create the ``conf`` directory in the
174 project directory: $ mkdir conf From within the ``conf`` directory, 174 project directory: $ mkdir conf From within the ``conf`` directory,
175 use some editor to create the ``bitbake.conf`` so that it contains 175 use some editor to create the ``bitbake.conf`` so that it contains
176 the following: `PN <#var-bb-PN>`__ = 176 the following: :term:`PN` =
177 "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] 177 "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0]
178 or 'defaultpkgname'}" TMPDIR = "${`TOPDIR <#var-bb-TOPDIR>`__}/tmp" 178 or 'defaultpkgname'}" TMPDIR = "${:term:`TOPDIR`}/tmp"
179 `CACHE <#var-bb-CACHE>`__ = "${TMPDIR}/cache" 179 :term:`CACHE` = "${TMPDIR}/cache"
180 `STAMP <#var-bb-STAMP>`__ = "${TMPDIR}/${PN}/stamps" 180 :term:`STAMP` = "${TMPDIR}/${PN}/stamps"
181 `T <#var-bb-T>`__ = "${TMPDIR}/${PN}/work" `B <#var-bb-B>`__ = 181 :term:`T` = "${TMPDIR}/${PN}/work" :term:`B` =
182 "${TMPDIR}/${PN}" 182 "${TMPDIR}/${PN}"
183 183
184 .. note:: 184 .. note::
@@ -287,9 +287,9 @@ Following is the complete "Hello World" example.
287 and the ``conf`` directory: $ cd $HOME $ mkdir mylayer $ cd mylayer 287 and the ``conf`` directory: $ cd $HOME $ mkdir mylayer $ cd mylayer
288 $ mkdir conf Move to the ``conf`` directory and create a 288 $ mkdir conf Move to the ``conf`` directory and create a
289 ``layer.conf`` file that has the following: BBPATH .= 289 ``layer.conf`` file that has the following: BBPATH .=
290 ":${`LAYERDIR <#var-bb-LAYERDIR>`__}" `BBFILES <#var-bb-BBFILES>`__ 290 ":${:term:`LAYERDIR`}" :term:`BBFILES`
291 += "${LAYERDIR}/*.bb" 291 += "${LAYERDIR}/*.bb"
292 `BBFILE_COLLECTIONS <#var-bb-BBFILE_COLLECTIONS>`__ += "mylayer" 292 :term:`BBFILE_COLLECTIONS` += "mylayer"
293 `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ := 293 `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ :=
294 "^${LAYERDIR_RE}/" For information on these variables, click the 294 "^${LAYERDIR_RE}/" For information on these variables, click the
295 links to go to the definitions in the glossary. 295 links to go to the definitions in the glossary.
@@ -297,8 +297,8 @@ Following is the complete "Hello World" example.
297 You need to create the recipe file next. Inside your layer at the 297 You need to create the recipe file next. Inside your layer at the
298 top-level, use an editor and create a recipe file named 298 top-level, use an editor and create a recipe file named
299 ``printhello.bb`` that has the following: 299 ``printhello.bb`` that has the following:
300 `DESCRIPTION <#var-bb-DESCRIPTION>`__ = "Prints Hello World" 300 :term:`DESCRIPTION` = "Prints Hello World"
301 `PN <#var-bb-PN>`__ = 'printhello' `PV <#var-bb-PV>`__ = '1' python 301 :term:`PN` = 'printhello' :term:`PV` = '1' python
302 do_build() { bb.plain("********************"); bb.plain("\* \*"); 302 do_build() { bb.plain("********************"); bb.plain("\* \*");
303 bb.plain("\* Hello, World! \*"); bb.plain("\* \*"); 303 bb.plain("\* Hello, World! \*"); bb.plain("\* \*");
304 bb.plain("********************"); } The recipe file simply provides 304 bb.plain("********************"); } The recipe file simply provides