summaryrefslogtreecommitdiffstats
path: root/bitbake/lib/layerindexlib/README
diff options
context:
space:
mode:
authorMark Hatle <mark.hatle@windriver.com>2018-07-23 22:29:11 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-08-02 10:18:27 +0100
commit1ac19d1bf111a4836625f5cbb28a751d5c427395 (patch)
treeae9fa1448b425522952cbc8af90cf79912c746b1 /bitbake/lib/layerindexlib/README
parent0dea95093115acc08f6ad19dc931d532a601cbec (diff)
downloadpoky-1ac19d1bf111a4836625f5cbb28a751d5c427395.tar.gz
bitbake: layerindexlib: Initial layer index processing module implementation
The layer index module is expected to be used by various parts of the system in order to access a layerindex-web (such as layers.openembedded.org) and perform basic processing on the information, such as dependency scanning. Along with the layerindex implementation are associated tests. The tests properly honor BB_SKIP_NETTESTS='yes' to prevent test failures. Tests Implemented: - Branch, LayerItem, LayerBranch, LayerDependency, Recipe, Machine and Distro objects - LayerIndex setup using the layers.openembedded.org restapi - LayerIndex storing and retrieving from a file - LayerIndex verify dependency resolution ordering - LayerIndex setup using simulated cooker data (Bitbake rev: fd0ee6c10dbb5592731e56f4c592fe687682a3e6) Signed-off-by: Mark Hatle <mark.hatle@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/lib/layerindexlib/README')
-rw-r--r--bitbake/lib/layerindexlib/README28
1 files changed, 28 insertions, 0 deletions
diff --git a/bitbake/lib/layerindexlib/README b/bitbake/lib/layerindexlib/README
new file mode 100644
index 0000000000..5d927afdf7
--- /dev/null
+++ b/bitbake/lib/layerindexlib/README
@@ -0,0 +1,28 @@
1The layerindexlib module is designed to permit programs to work directly
2with layer index information. (See layers.openembedded.org...)
3
4The layerindexlib module includes a plugin interface that is used to extend
5the basic functionality. There are two primary plugins available: restapi
6and cooker.
7
8The restapi plugin works with a web based REST Api compatible with the
9layerindex-web project, as well as the ability to store and retried a
10the information for one or more files on the disk.
11
12The cooker plugin works by reading the information from the current build
13project and processing it as if it were a layer index.
14
15
16TODO:
17
18__init__.py:
19Implement local on-disk caching (using the rest api store/load)
20Implement layer index style query operations on a combined index
21
22common.py:
23Stop network access if BB_NO_NETWORK or allowed hosts is restricted
24
25cooker.py:
26Cooker - Implement recipe parsing
27
28