[v2,2/3] doc: Update tasks description

Message ID 20211028171727.246342-3-amikan@ilbers.de
State Changes Requested
Headers show
Series Update Isar documentation | expand

Commit Message

Anton Mikanovich Oct. 28, 2021, 8:17 a.m. UTC
Update task list and description for `dpkg.bbclass` and
`dpkg-raw.bbclass` to correspond with the latest state.

Signed-off-by: Anton Mikanovich <amikan@ilbers.de>
---
 doc/technical_overview.md | 56 +++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 23 deletions(-)

Patch

diff --git a/doc/technical_overview.md b/doc/technical_overview.md
index bbd22b6..225475e 100644
--- a/doc/technical_overview.md
+++ b/doc/technical_overview.md
@@ -214,41 +214,51 @@  Both consist of the following steps:
 
 2. Task `do_unpack`: unpack those files to `${WORKDIR}`
 
-3. Task `do_install` _only_ for `dpkg-raw`: copy all you want in your
+3. Task `do_transform_template`: process `${TEMPLATE_FILES}` to substitute
+   variables listed in `${TEMPLATE_VARS}` in template files
+
+4. Task `do_apt_fetch`: fetch source files from apt repos
+
+5. Task `do_apt_unpack`: unpack those files to `${WORKDIR}`
+
+6. Task `do_patch`: process .patch files in the `${SRC_URI}`
+
+7. Task `do_install` _only_ for `dpkg-raw`: copy all you want in your
    debian package to `${D}`, install hooks in `${D}/DEBIAN`
 
-4. Task `do_prepare': perform any preparation steps to the unpacked/patched
-   sources before the build. This task calls the dpkg_prepare shell function
-   with the buildchroot mounts in place (`dpkg_do_mounts')
+8. Task `do_adjust_git`: adjust alternates links inside git repos in the
+   package workdir to make them valid inside chroot
+
+9. Task `do_prepare_build`: perform any preparation steps to the unpacked and
+   patched sources before the build.
 
-   4.1. the `dpkg_prepare` function of `dpkg.bbclass` runs `/isar/deps.sh` in
-        the buildchroot. That performs the following:
+   For `dpkg-raw` it perform `deb_debianize` call to translate the recipe
+   meta-data into a debian/* files suitable for building with dpkg-buildpackage
 
-        1. Go to `/home/build/${PN}`
+10. Task `do_install_builddeps`: install build dependencies of the package.
+    This task calls the `builddeps_install` shell function with the buildchroot
+    mounts in place (surrounded by `dpkg_do_mounts` and `dpkg_undo_mounts`).
 
-        2. Get list of dependencies from debian/control and install them
+    The `builddeps_install` function of `dpkg.bbclass` runs `/isar/deps.sh` in
+    the buildchroot. That performs the following:
 
-   4.2. the `dpkg_prepare` function of `dpkg-raw.bbclass` translate the
-        recipe meta-data into a debian/control file suitable for packaging
-        with dpkg-deb
+    10.1. Go to `/home/build/${PN}`
 
-5. Task `do_build`: mount folder (`dpkg_do_mounts') with unpacked files to buildchroot,
-   execute the actual build function `dpkg_runbuild`, and finally umount again
-   (`dpkg_undo_mounts')
+    10.2. Get list of dependencies from debian/control and install them
 
-   5.1. the `dpkg_runbuild` function of `dpkg.bbclass` runs `build.sh` in the
-        buildchroot. That performs the following:
+11. Task `do_dpkg_build`: mount folder (`dpkg_do_mounts`) with unpacked files
+    to buildchroot, execute the actual build function `dpkg_runbuild`, and
+    finally umount again (`dpkg_undo_mounts`)
 
-        1. Go to `/home/build/${PN}`
+    The `dpkg_runbuild` function of `dpkg.bbclass` runs `/isar/build.sh` in
+    the buildchroot. That performs the following:
 
-        2. Run dpkg-buildpackage
+    11.1. Go to `/home/build/${PN}`
 
-   5.2. the `dpkg_runbuild` function of `dpkg-raw.bbclass` basically runs
-        `dpkg-deb` to construct a Debian package from a folder of files,
-	without compiling anything
+    11.2. Run dpkg-buildpackage
 
-6. Task `do_deploy_deb`: install successfully built packages
-   `${WORKDIR}/*.deb` to deploy directory `${DEPLOY_DIR_DEB}`
+12. Task `do_deploy_deb`: install successfully built packages
+    `${WORKDIR}/*.deb` to deploy directory `${DEPLOY_DIR_DEB}`
 
 ## 3.6 Populate Target Filesystem