diff mbox series

[3/5] ref-manual: Describe new package feed directories.

Message ID 20230817155143.2578874-4-charlie.johnston@ni.com
State New
Headers show
Series Add packagefeed class documentation. | expand

Commit Message

Charlie Johnston Aug. 17, 2023, 3:50 p.m. UTC
The addition of the packagefeed class adds several new
directories to the build directory structure. This change
adds documentation for the ${DEPLOY_DIR_FEED} directory
and its subdirectories.

Signed-off-by: Charlie Johnston <charlie.johnston@ni.com>
---
 documentation/ref-manual/structure.rst | 36 ++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index f1b11ad69..9e0a20441 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -431,6 +431,42 @@  types.
 
 This directory receives ``.ipk`` packages produced by the build process.
 
+.. _structure-build-tmp-deploy-feeds:
+
+``build/tmp/deploy/feeds/``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This directory contains any "end result" feeds which are deploy-ready from
+the OpenEmbedded build process. The :term:`DEPLOY_DIR_FEED` variable points
+to this directory. There are subdirectories for each supported package class.
+
+.. _structure-build-tmp-deploy-feeds-deb:
+
+``build/tmp/deploy/feeds/deb/``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This directory receives any ``.deb`` package feeds that are produced by the
+build process. Feeds are placed in a containing directory including with the
+name of the feed.
+
+.. _structure-build-tmp-deploy-feeds-rpm:
+
+``build/tmp/deploy/feeds/rpm/``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This directory receives any ``.rpm`` package feeds that are produced by the
+build process. Feeds are placed in a containing directory including with the
+name of the feed.
+
+.. _structure-build-tmp-deploy-feeds-ipk:
+
+``build/tmp/deploy/feeds/ipk/``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This directory receives any ``.ipk`` package feeds that are produced by the
+build process. Feeds are placed in a containing directory including with the
+name of the feed.
+
 .. _structure-build-tmp-deploy-licenses:
 
 ``build/tmp/deploy/licenses/``