Skip to content

Commit f15a845

Browse files
committed
docs(README): fix errors, simplify
1 parent e32d921 commit f15a845

File tree

2 files changed

+12
-36
lines changed

2 files changed

+12
-36
lines changed

README.md

+12-36
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,27 @@
11
# meta-bitbake-variable-substitution
2-
Expands bitbake variables in external source/scripts.
2+
Automatically expand bitbake variables inside source/scripts.
33

44
## Overview
5-
* delimited bitbake variables in external source/scripts will be replaced with the expanded value of that bitbake variable
5+
* delimited bitbake variables in source/scripts will be replaced with the expanded value of that bitbake variable
66
* Example: ``@@sbindir@@`` will be replaced with ``/usr/sbin``
7-
* delimiter defaults to ``@@``. This can be overriden with the variable ``BITBAKE_VAR_SUB_DELIM``
87
* files in ``FILES_${PN}`` are expanded automatically, during ``do_install:append()``
9-
* files in ``SRC_URI`` are expanded automatically, during ``do_compile:prepend()``
10-
* any file can be processed with an explict function call
11-
* see [Using Layer](#Using-Layer) for more info
8+
* files in ``SRC_URI`` are expanded automatically, during ``do_patch:append()``
9+
* any file can be processed with an explict function call inside bitbake recipe
1210

13-
## Dependencies
14-
This layer depends on:
15-
16-
URI: git://git.openembedded.org/bitbake
17-
18-
URI: git://git.openembedded.org/openembedded-core
19-
layers: meta
20-
branch: master
21-
22-
## Installation
23-
### Add Layer to Build
24-
In order to use this layer, the build system must be aware of it.
25-
26-
Assuming this layer exists at the top-level of the yocto build tree; add the location of this layer to ``bblayers.conf``, along with any additional layers needed:
27-
28-
BBLAYERS ?= " \
29-
/path/to/yocto/meta \
30-
/path/to/yocto/meta-poky \
31-
/path/to/yocto/meta-yocto-bsp \
32-
/path/to/yocto/meta-bitbake-variable-substitution \
33-
"
34-
35-
Alternatively, run bitbake-layers to add:
36-
37-
$ bitbake-layers add-layer /path/to/yocto/meta-bitbake-variable-substitution
38-
39-
### Configuration
11+
## Configuration
4012
| Variable | Default | Description |
4113
| --- | --- | --- |
4214
| ``BITBAKE_VAR_SUB_DELIM`` | ``@@`` | strings sandwiched between this delim will be replaced w/ value of bitbake variable of same name |
43-
| ``BITBAKE_VAR_SUB_MISSING_VAR_FATAL`` | ``1`` | missing bitbake variables will be a fatal error |
15+
| ``BITBAKE_VAR_SUB_MISSING_VAR_FATAL`` | ``1`` | missing bitbake variables will cause a fatal error |
4416

45-
## Using Layer
17+
## Usage
18+
### Automatic Expansion
4619
To automatically process files, add ``inherit bitbake-variable-substitution`` to recipe.
4720

48-
Alternatively, a more measured approach may be preferred, especially if `FILES_${PN}` or `SRC_URI` is trashy/bloated. To explicitly/manually select files to process:
21+
### Explicit Expansion
22+
Alternatively, a more measured approach may be preferred. Especially useful if `FILES_${PN}` or `SRC_URI` is trashy/bloated.
23+
24+
To explicitly/manually select files to process:
4925

5026
# inherit helpers class in recipe
5127
inherit bitbake-variable-substitution-helpers

0 commit comments

Comments
 (0)