From patchwork Wed Mar 29 08:28:07 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Srinuvasan Arjunan X-Patchwork-Id: 2748 Return-Path: Received: from shymkent.ilbers.de ([unix socket]) by shymkent (Cyrus 2.5.10-Debian-2.5.10-3+deb9u2) with LMTPA; Wed, 29 Mar 2023 10:28:47 +0200 X-Sieve: CMU Sieve 2.4 Received: from mail-ua1-f59.google.com (mail-ua1-f59.google.com [209.85.222.59]) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8+deb9u1) with ESMTPS id 32T8Sk2L002114 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 29 Mar 2023 10:28:46 +0200 Received: by mail-ua1-f59.google.com with SMTP id 93-20020a9f2066000000b00743dc8a5085sf6905183uam.7; Wed, 29 Mar 2023 01:28:46 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1680078520; cv=pass; d=google.com; s=arc-20160816; b=1BMc8DdqSrq9Wzb7JXSXUuWga9476+dDxITiC+5OTyTveZ9zbciFPUWI/mCGWA5eBO FdXYpLw9R5c+4fZyvgqLvfOGP/yNlWdF35zHgXb4TyAJX/z0x/HvVYe5sARLnqTqJnya lBXgICYktkadmWXWNw5sIvGi9BKLoAF2NB51PzwVz4T6GZlf3SCrA7rUWFaDLtea+4fo 4BSkbNd3UNEVQqqdCToLePRzGMhvqBz/v4/GaI6jKQ0HC3v+8EZw/tPH+jsDCK8O+721 24LroZKd+26IG1H/ncDCjbC/qw4Mi1zE3ercZR2i5CvCKuLCNTxYgNcuOy0wy+SYPJ0U 5qzA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:content-transfer-encoding :mime-version:message-id:date:subject:cc:to:from:ironport-sdr:sender :dkim-signature; bh=ZxeOQ4uGWXV6bH4hZd38/XEQHVLTNYyk2J18zMaExwA=; b=HPtbzpZPKEk+FXb7MZ599J849GuRdtm1c+Px3kY4NGKjZG3lhc/fLAsmIjB/kiCjFm 4yCniT8eJEGU8NDrnDSg2hcBMHecX7+5NpYB/vqaLUPp3SrmBxTUE5tfSr9FEWoTZjik Qll1hj9eKNdKzSLiOhyl/XlLNEyvukb0Tk0Z5cZDtzttIgQIVMtGxjNTWwGj7CvVGaKf 5PiT59ZhNYlokKIVYWiyRaa2zy4TtzHzyQbKz7v+bWNAruf8oK6fMDRzUHtpBLtB7I8c THOieRmTqOH1+NNCT8VUUFpBaFqTRx95g4eC0OD54LUZRJAQjOZjCCaxqg+L/gkwfWOs wk7g== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.141.98 as permitted sender) smtp.mailfrom=Srinuvasan_A@mentor.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20210112; t=1680078520; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:x-original-authentication-results :x-original-sender:content-transfer-encoding:mime-version:message-id :date:subject:cc:to:from:ironport-sdr:sender:from:to:cc:subject:date :message-id:reply-to; bh=ZxeOQ4uGWXV6bH4hZd38/XEQHVLTNYyk2J18zMaExwA=; b=m6cEGlblW5yYJ85abVzxdvvutI3QdSA14uF4N2iCAjZ8eTwGEmJWYb6UH9l27/im+B sdrr5VESPmY2vrh9bF/5Rr553AOPiZCVOgkfzE+c5y4h9hGh4kFU7rqSBzgfX/aGLhzW CK2jW29HabcaWSpbXmkcLTDWc2Y5WHY43c7Kymqzh4h9wFbTbmRbEfcDJeiGyzHrFe/Y NL0JRlj/mM4/jHEAIxGD0jOJRzTYhYWPJ86f02qtsQw452mKmnC/+jnKqOC36e3Ys7PG zFGCg8ke2RrkVy9BhDfJwr9p0q5Z4LdAEbbZJTTDNhJwUKH2zgEzz77qGdzyGU4v8Y/K lnvQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680078520; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :x-spam-checked-in-group:list-id:mailing-list:precedence :x-original-authentication-results:x-original-sender :content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:ironport-sdr:x-gm-message-state:sender:from:to:cc:subject :date:message-id:reply-to; bh=ZxeOQ4uGWXV6bH4hZd38/XEQHVLTNYyk2J18zMaExwA=; b=QXf6iV8Q/Oh27zA6g6cIURCr8yLFM085W269VBJim9fxl7wexqIiCJO+OzAKWR9A7v HObkd1QKVjn4a5DNUnAkb8XDMbvURcFbTNbBbFqEdcmfPibq/y+AbLpWyVbQwBeFoAjS ZV42O+ZCRlemDgSvZtogXEoaDmMCMFmmEKp6H16YJKlIX7N4NyLe4rCWcD9L9PLV7Tso q6xeuIkAlESGeDy5mrCsUX0A0M/OnCdEfnpHZdAVdoDz9UOOsTf6giDLxgXmOuusJbre 7sMo2UCwDc8QP9sgQBAEU+Lh+2Xnga3NP0l2YPiQkg1JpxWbd3mrOdFW+Ff4p7QLtAWy JB6Q== Sender: isar-users@googlegroups.com X-Gm-Message-State: AAQBX9dyvIz4UcdUeQPQpA7l+TCFAPjEdCYR0S+oqNLURTbKK4XfClpc ndaHzERzchaWKI8YftB7NuE= X-Google-Smtp-Source: AKy350b6iOtHg21x6G4fGKhCmg/UGGmagkgf+5rWxCXlrMRdKxXWu+vwrY94auPZd6AgtuG/fr+5gQ== X-Received: by 2002:a67:c202:0:b0:425:d096:fd42 with SMTP id i2-20020a67c202000000b00425d096fd42mr9760702vsj.5.1680078520522; Wed, 29 Mar 2023 01:28:40 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a05:6102:5592:b0:41f:41ea:30ac with SMTP id dc18-20020a056102559200b0041f41ea30acls2990981vsb.5.-pod-prod-gmail; Wed, 29 Mar 2023 01:28:39 -0700 (PDT) X-Received: by 2002:a05:6102:2848:b0:421:df50:2b7c with SMTP id az8-20020a056102284800b00421df502b7cmr6894463vsb.7.1680078519871; Wed, 29 Mar 2023 01:28:39 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680078519; cv=none; d=google.com; s=arc-20160816; b=W1plAJ3JHH+A9E3Q4tMCgdSaHAwhIiFMY6iPfAVEW1TodpLPKl25kFsbu0TlC/dAc8 HcZex3SvoJ7kpXYmBryvmwnwEn9WwxmTwiMOHwbt3rWEFpk5WXUZjeY27+1kbb6xyeOX bE3tgI49bw/7+vm/DQB3/UEcUbgJXd62BOjMAW32X+0x2+Qe/LjCXo1kTdsbw0BRInpH fWr+tfJ5EjP4yilA4f7NY4o7xLS+VOuecaiDB6ZeNf1R5/qfG7qN3FZFZtJcXCCrKOa5 q3QT2ZPq5n+sj7hhL6Nx3iCxw0k2S8X10yXrcXZJbXjXcsnD5rseTAgQAm2jb6AC04P1 ISDw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:ironport-sdr; bh=Z/pUVxTyiTdBS+aNAyVmv0X/E3fGvPMckObYbZ2obwo=; b=sr7SrxRLM0AROOAlfLcEKXVKpqhWYS10qii2GfEhvzzhqCjep3oX5Xz26TC3rHV7WC NtGC0+8r+CEjxlJPr6HMoGi3pNS3MPN7h4BxlY1PP6jt5fQRCHcRFO24TC01+qv/oDfu 5DgUk5DHQRasTTvVYI8FV8mxBxkmK57D/6JWGza0qY07PXO1s8BWCQJeUCcNDtwccRRG x7A1dUcAHV775164MGFVLqm6lhHFPHFZIPS5b8+scD8xP8GffchJL+dj7FsV2gCSBsay R/W/0jG36GTqAKKrePe4xgHvTuvP8BVyHxakA7KS0AQmaflvnE5zezYKczSKB8B02LuP obZw== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.141.98 as permitted sender) smtp.mailfrom=Srinuvasan_A@mentor.com Received: from esa2.mentor.iphmx.com (esa2.mentor.iphmx.com. [68.232.141.98]) by gmr-mx.google.com with ESMTPS id f37-20020ab014e8000000b00690829432ebsi3262862uae.2.2023.03.29.01.28.39 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 29 Mar 2023 01:28:39 -0700 (PDT) Received-SPF: pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.141.98 as permitted sender) client-ip=68.232.141.98; X-IronPort-AV: E=Sophos;i="5.98,300,1673942400"; d="scan'208";a="842742" Received: from orw-gwy-01-in.mentorg.com ([192.94.38.165]) by esa2.mentor.iphmx.com with ESMTP; 29 Mar 2023 00:28:38 -0800 IronPort-SDR: sMuGhd05O2U7Ya2/zC7an5ZCJrIVuth1ENh6jNbzSOiIVzd6cnTlyeSMlAtX3ZMedoE6zjEplM OJ/lertoG/w8NfSORu92aUAj9vW9uhjE6kQV3SeqtUMlI1Zq4gafBgRoEmB6i1875ME50G7Oit GLjnCcf0XdCNh5FabsS8kBmv/1+Gd6PbIfe0lAz9PwCyJSlc9puIbEgcQT6XL+EBPKIqL4Zysg QDMfjJl5l8xmDrrtgFYlNtRZWXcDd7+GN7xqyC4P9/pHHmLcdV5zZRaeQDUcNGQMa2dJWQMypq uT8= From: Srinuvasan Arjunan To: CC: , Srinuvasan A Subject: [PATCH] doc/user_manual.md: Fix typo Date: Wed, 29 Mar 2023 13:58:07 +0530 Message-ID: <20230329082807.355898-1-srinuvasan_a@mentor.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-ClientProxiedBy: svr-orw-mbx-12.mgc.mentorg.com (147.34.90.212) To svr-orw-mbx-13.mgc.mentorg.com (147.34.90.213) X-Original-Sender: srinuvasan_a@mentor.com X-Original-Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.141.98 as permitted sender) smtp.mailfrom=Srinuvasan_A@mentor.com Precedence: list Mailing-list: list isar-users@googlegroups.com; contact isar-users+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: isar-users@googlegroups.com X-Google-Group-Id: 914930254986 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_EF,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shymkent.ilbers.de X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= From: Srinuvasan A Fix typo and update the image artifacts in user manual. Signed-off-by: Srinuvasan A --- doc/user_manual.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/user_manual.md b/doc/user_manual.md index 3db5eb2..a41c80e 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -137,8 +137,8 @@ In the editor, allow the current user to run sudo without a password, e.g.: ALL=(ALL:ALL) NOPASSWD:ALL Defaults env_keep += "ftp_proxy http_proxy https_proxy no_proxy" ``` -Replace `` with your user name. Use the tab character between the user name and parameters. -The second line will make sure your proxy settings will not get lost when using `sudo`. Include it if you are in the unfortunate possition to having to deal with that. +Replace `` with your username. Use the tab character between the username and parameters. +The second line will make sure your proxy settings will not get lost when using `sudo`. Include it if you are in the unfortunate position to having to deal with that. ### Check out Isar @@ -178,8 +178,8 @@ bitbake mc:qemuarm-buster:isar-image-base \ The following images are created: ``` -tmp/deploy/images/qemuarm/isar-image-base-qemuarm-debian-buster.ext4.img -tmp/deploy/images/qemuarm/isar-image-debug-qemuarm-debian-buster.ext4.img +tmp/deploy/images/qemuarm/isar-image-base-qemuarm-debian-buster.ext4 +tmp/deploy/images/qemuarm/isar-image-debug-qemuarm-debian-buster.ext4 ``` ### Building Target Images for Multiple Configurations @@ -209,10 +209,10 @@ $ bitbake \ Created images are: ``` -tmp/deploy/images/qemuarm/isar-image-base-debian-buster-qemuarm.ext4.img -tmp/deploy/images/qemuarm64/isar-image-base-debian-buster-qemuarm64.ext4.img -tmp/deploy/images/qemui386/isar-image-base-debian-buster-qemui386.wic.img -tmp/deploy/images/qemuamd64/isar-image-base-debian-buster-qemuamd64.wic.img +tmp/deploy/images/qemuarm/isar-image-base-debian-buster-qemuarm.ext4 +tmp/deploy/images/qemuarm64/isar-image-base-debian-buster-qemuarm64.ext4 +tmp/deploy/images/qemui386/isar-image-base-debian-buster-qemui386.wic +tmp/deploy/images/qemuamd64/isar-image-base-debian-buster-qemuamd64.wic ``` ### Generate full disk image @@ -238,18 +238,18 @@ enough to allow images to be testable under `qemu`. ``` # AMD64 image, EFI -qemu-system-x86_64 -m 256M -nographic -bios edk2/Build/OvmfX64/RELEASE_*/FV/OVMF.fd -hda tmp/deploy/images/qemuamd64/isar-image-base-debian-buster-qemuamd64.wic.img +qemu-system-x86_64 -m 256M -nographic -bios edk2/Build/OvmfX64/RELEASE_*/FV/OVMF.fd -hda tmp/deploy/images/qemuamd64/isar-image-base-debian-buster-qemuamd64.wic # i386 image -qemu-system-i386 -m 256M -nographic -hda tmp/deploy/images/qemui386/isar-image-base-debian-buster-qemui386.wic.img +qemu-system-i386 -m 256M -nographic -hda tmp/deploy/images/qemui386/isar-image-base-debian-buster-qemui386.wic ``` #### Flashing such images to a physical device -wic images can be flashed in multiple ways. The most generic and easy way is probably with [ etcher ](https://etcher.io). That works on many operating systems and is relatively easy to use. On top it can decompress images on the fly, should they be compressed. It also offers some sort of protection so you do not write to the wrong device and maybe break your machine. +wic images can be flashed in multiple ways. The most generic and easy way is probably with [ etcher ](https://etcher.io). That works on many operating systems and is relatively easy to use. On top it can decompress images on the fly, should they be compressed. It also offers some sort of protection, so you do not write to the wrong device and maybe break your machine. If you have a unix shell there are other ways. Make sure to always double check the target device, those tools might not warn if you choose the wrong target. -`bmaptool` would be the best choice on a Linux/Unix system. It offers skipping of empty space and will flash much faster than `dd`, it also has some protection so you do not flash over a mounted drive by accident. Unfortunately it is not yet available on all Linux distributions. +`bmaptool` would be the best choice on a Linux/Unix system. It offers skipping of empty space and will flash much faster than `dd`, it also has some protection, so you do not flash over a mounted drive by accident. Unfortunately, it is not yet available on all Linux distributions. https://github.com/intel/bmap-tools `dd` is the most generic option, available pretty much everywhere. But here you really need to make sure to not write to the wrong target. @@ -262,7 +262,7 @@ one of the supported container formats `oci`, `oci-archive`, `docker-archive`, Getting a container image can be the main purpose of an Isar configuration, but not only. A container image created from an Isar configuration meant for bare-metal or -virtual machines can be helpfull to test certain applications which +virtual machines can be helpful to test certain applications which requirements (e.g. libraries) can be easily resolved in a containerized environment. @@ -410,14 +410,14 @@ all supported configurations: Some other variables include: - `IMAGE_INSTALL` - The list of custom packages to build and install to target image, please refer to relative chapter for more information. - - `BB_NUMBER_THREADS` - The number of `bitbake` jobs that can be run in parallel. Please set this option according your host CPU cores number. + - `BB_NUMBER_THREADS` - The number of `bitbake` jobs that can be run in parallel. Please set this option according to your host CPU cores number. - `HOST_DISTRO` - The distro to use for SDK root filesystem. This variable is optional. - `HOST_ARCH` - The Debian architecture of SDK root filesystem (e.g., `amd64`). By default set to current Debian host architecture. This variable is optional. - `HOST_DISTRO_APT_SOURCES` - List of apt source files for SDK root filesystem. This variable is optional. - `HOST_DISTRO_APT_PREFERENCES` - List of apt preference files for SDK root filesystem. This variable is optional. - `HOST_DISTRO_BOOTSTRAP_KEYS` - Analogously to DISTRO_BOOTSTRAP_KEYS: List of gpg key URIs used to verify apt bootstrap repo for the host. - `DISTRO_APT_PREMIRRORS` - The preferred mirror (append it to the default URI in the format `ftp.debian.org my.preferred.mirror`. This variable is optional. PREMIRRORS will be used only for the build. The final images will have the sources list as mentioned in DISTRO_APT_SOURCES. - - `THIRD_PARTY_APT_KEYS` - List of gpg key URIs used to verify apt repos for apt installation after bootstrapping + - `THIRD_PARTY_APT_KEYS` - List of gpg key URIs used to verify apt repos for apt installation after bootstrapping. - `FILESEXTRAPATHS` - The default directories BitBake uses when it processes recipes are initially defined by the FILESPATH variable. You can extend FILESPATH variable by using FILESEXTRAPATHS. - `FILESOVERRIDES` - A subset of OVERRIDES used by the build system for creating FILESPATH. The FILESOVERRIDES variable uses overrides to automatically extend the FILESPATH variable. - `IMAGER_INSTALL` - The list of package dependencies for an imager like wic. @@ -861,7 +861,7 @@ You might be able to find a debianization for a component on the internet, i.e. You can write it yourself, which can be pretty easy but requires a bit of studying. -Isar does actually contain a helper that aims to "debianize" sources for your. If your package uses a build-system that Debian knows and follows the well known "configure", "compile", "install" scheme that debianization might just fit your needs without reading Debian manuals. +Isar does actually contain a helper that aims to "debianize" sources for you. If your package uses a build-system that Debian knows and follows the well known "configure", "compile", "install" scheme that debianization might just fit your needs without reading Debian manuals. If it does not fully fit your needs, it probably gives you a good starting point for your manual tuning. The shell function `deb_debianize` creates a `debian` folder. But it will not overwrite files that already are in WORKDIR. So you can either just call it to fully generate the `debian` folder. Or you combine it with pre-existing parts. @@ -874,7 +874,7 @@ If your customization is not about compiling from source there is a second way o - packaging binaries/files that where built outside of Isar - customization of the rootfs with package-hooks - - pulling in dependancies (meta-packages) + - pulling in dependencies (meta-packages) The bbclass for this approach is called `dpkg-raw`. @@ -971,7 +971,7 @@ concept. Isar can build 32-bit packages as part of a 64-bit image build and also enable the image with the necessary packages. To activate compat support, -set `ISAR_ENABLE_COMPAT_ARCH = "1"` in `local.conf`. This will install neccessary +set `ISAR_ENABLE_COMPAT_ARCH = "1"` in `local.conf`. This will install necessary build dependencies in the buildchroot. For all dpkg package recipes, Isar automatically provides a `-compat` @@ -1049,7 +1049,7 @@ To build without using any sstate caching, you can use the bitbake argument ### Motivation Building applications for targets in ISAR takes a lot of time as they are built under QEMU. -SDK providing crossbuild environment will help to solve this problem. +SDK providing cross build environment will help to solve this problem. ### Approach @@ -1337,7 +1337,7 @@ With the current base-apt implementation, we already cache all the binary packag we download and install onto the target rootfs and buildchroot. This is then used to generate a local-apt for offline build. -Use rootfs postprocessing to parse through the the list of deb files in ${DEBDIR} and +Use rootfs postprocessing to parse through the list of deb files in ${DEBDIR} and download the corresponding Debian source file using "apt-get source" command. This caches the sources of all the Debian packages that are downloaded and installed onto the target rootfs and buildchroots.