summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml50
1 files changed, 50 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ad4a7613a9..cedab513bb 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -342,6 +342,56 @@
342 Future versions of BitBake might address this.</para> 342 Future versions of BitBake might address this.</para>
343 </note> 343 </note>
344 </section> 344 </section>
345
346 <section id='managing-layers'>
347 <title>Managing Layers</title>
348
349 <para>
350 You can use the BitBake layer management tool to provide a view into the structure of
351 recipes across a multi-layer project.
352 Being able to generate output that reports on configured layers with their paths and
353 priorities and on <filename>.bbappend</filename> files and their applicable recipes
354 can help to reveal potential problems.
355 </para>
356
357 <para>
358 Use the following form when running the layer management tool.
359 <literallayout class='monospaced'>
360 $ bitbake-layers &lt;command&gt; [arguments]
361
362 Available commands:
363 flatten
364 flattens layer configuration into a separate output directory.
365 help
366 display general help or help on a specified command
367 show_appends
368 list bbappend files and recipe files they apply to
369 show_layers
370 show current configured layers
371 show_overlayed
372 list overlayed recipes (where there is a recipe in another layer that has a higher layer priority)
373 help
374 display general help or help on a specified command
375 </literallayout>
376 </para>
377
378 <para>
379 Flattening your layer configuration builds a "flattened" directory that contains
380 the contents of all layers, with any overlayed recipes removed and any
381 recipe append files (<filename>.bbappend</filename>) appended to the corresponding recipes.
382 You might have to perform some manual cleanup of the flattened layer as follows:
383 <itemizedlist>
384 <listitem><para>Non-recipe files (such as patches) are overwritten.
385 The flatten command shows a warning for these files.</para></listitem>
386 <listitem><para>Anything beyond the normal layer setup has been added to
387 the <filename>layer.conf</filename> file.
388 Only the lowest priority layer's <filename>layer.conf</filename> is used.
389 </para></listitem>
390 <listitem><para>Overridden and appended items from <filename>.bbappend</filename>
391 files never need to be cleaned up.</para></listitem>
392 </itemizedlist>
393 </para>
394 </section>
345 </section> 395 </section>
346 396
347 <section id='usingpoky-extend-addpkg'> 397 <section id='usingpoky-extend-addpkg'>