From patchwork Wed Mar 29 08:11:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Srinuvasan Arjunan X-Patchwork-Id: 2747 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:27:25 +0200 X-Sieve: CMU Sieve 2.4 Received: from mail-oa1-f56.google.com (mail-oa1-f56.google.com [209.85.160.56]) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8+deb9u1) with ESMTPS id 32T8RNhs002093 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 29 Mar 2023 10:27:24 +0200 Received: by mail-oa1-f56.google.com with SMTP id 586e51a60fabf-17714741d9dsf7870008fac.4; Wed, 29 Mar 2023 01:27:24 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1680078437; cv=pass; d=google.com; s=arc-20160816; b=Zl9xKqx64zGxAjsPggeoVDqdITSsgtLudccRL+P0HGmDfRAckrO6SwIRFWDeY5VUet uHG79KQx8ikPltvdHisEbkfzDSqLPkhwjesYEc6pfTXKYTYFV7WlFyyXdtISF8KqUsJ5 6cC1H+COPdLkeUXRTl4Z0hS/vX1V0KYEHWQMAlmJh1jIGhl92oExg2bPQc7MueRVSwLw TUUQure1fReKALAR6QY/VxesN3FS0/o1KtTmYu2ah3cdYydzPoKFFoieyGITs8EyhGXS uhnukGmAyOIu5cPIcqIoO1tlXIqJybp2PKDvk6qCL7w0IfcXi2q5R3L9LKANBiYOmXrP mYJA== 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=YivEaFlb7s62BnljoIIVT8zHH5rOzEVJfmGS+dIY4Zw=; b=TMhwpuZe3nxjfJiVGriP9YN6abJeAYIKgSM1CFbiKme0NUJxOpOPMXLp4rdet1K2Qa 5cwDgSaqi1nUYQsLGEgc+MXMCPeaQhhG02WqzXVpJtlOkpM9icxJdkp9HchVS1LgLpo2 wh91BaSOEh7iMb32CSpnqq2S+FXgWmP4vDxlWAqbWzjxXifR5agu6DIC2fL9p4Mf28VY lplhBebBUxmGHuaBERf0xG5rrHKPTF6JD0KJiNOZccWQoKAdSObt4JAWZvMbQ6Ot+NiB 33R1Hq5s7j+YGbjvacgswOXDiydk3S6Yu4FVJ3wtJa9xoKhASZPqEsllfHrioJV5lVDe 0TAg== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.129.153 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=1680078437; 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=YivEaFlb7s62BnljoIIVT8zHH5rOzEVJfmGS+dIY4Zw=; b=oltr1+kbQAK4yKbzKlpZzyY+/DdT5jlRdPhZzpeE9obG/Toy5vBVkuM6Wv3ITAXqly pB9aI9kPb/hTmmgQFG6B8gaZchriyAzj9bAiJ+gaz5WvdOy14x+CHKSbz2KK4OxIlzjv H39MmZ40qPYWBZ2c3csCk0r1V9IRcW+17PKbBWbX+EkMVldATQDV8paLwKz5kat/A531 LQ5HHrQ31KHGSL538xCZYoJ6hKrrmMNer23EIMSZ8W8xi46i8cLY0y/jFjvOh80HBbsa XRVju10nw2fOwfRxCzMCBhA5gGPxiUbdJRuBeBWWPwME9T4eOswfgxoYtKRiVF2hWPJP yv7A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680078437; 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:x-gm-message-state:sender:from :to:cc:subject:date:message-id:reply-to; bh=YivEaFlb7s62BnljoIIVT8zHH5rOzEVJfmGS+dIY4Zw=; b=QTDU+vZUaVIoidXSZNcGGTCHI5QTPjkgQLhW8VYNtgNOuawUJ28WGugpxQA1aiqBjT 9zmt41/HSzT9Kp6Cnbju7Lw11/Ctxh1SUru/Ov0ZJINWw8PYItKJ5TbcPaZTe/Sj4GC8 4YikhcPgCQw1kcvyeQRGeHuFMFYwZP1mD6tE6Bc1E2FNXQFEPpStFfpxDmOOCdaz4qNk VDH7sdrbDzXu6jU0c8+Gi8G7StbuthB9Pg33GoVzweyK/2Qo3f2tCvRh1yWtBHdB+Une xvalu2dov3g8ITYQuRpw0eaPpRzkgApKEQmdPfcJA+AjEg1FedBBMnggUIelQZYJbti0 oWcQ== Sender: isar-users@googlegroups.com X-Gm-Message-State: AAQBX9cLnOVxQQvPQOEYlqhXMFHcSmgAcefbkdQN+moL6j+6qyCi6FPQ tYVQ9SzeuwsW80pkL9GsAy4= X-Google-Smtp-Source: AKy350ZQ5RaUoijWwLQ8ubuBMDGFJQBFKYo7N16oDuuRuotSZsEq5BNqCNlzevsRrE6OJub6lyLPhA== X-Received: by 2002:a05:6870:f916:b0:177:90f5:b995 with SMTP id ao22-20020a056870f91600b0017790f5b995mr4704357oac.4.1680078437692; Wed, 29 Mar 2023 01:27:17 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a05:6808:1116:b0:387:24d4:f9b9 with SMTP id e22-20020a056808111600b0038724d4f9b9ls3308575oih.1.-pod-prod-gmail; Wed, 29 Mar 2023 01:27:17 -0700 (PDT) X-Received: by 2002:a05:6808:659:b0:387:1e2d:f281 with SMTP id z25-20020a056808065900b003871e2df281mr4865191oih.11.1680078437321; Wed, 29 Mar 2023 01:27:17 -0700 (PDT) Received: by 2002:a05:6808:2385:b0:386:9a93:ca0d with SMTP id 5614622812f47-3896551bdf7msb6e; Wed, 29 Mar 2023 01:12:21 -0700 (PDT) X-Received: by 2002:a17:90b:4ac8:b0:23f:91e5:103d with SMTP id mh8-20020a17090b4ac800b0023f91e5103dmr19455377pjb.36.1680077540728; Wed, 29 Mar 2023 01:12:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680077540; cv=none; d=google.com; s=arc-20160816; b=sKNP1AAdXpEmXhaKL/1zWYNCLxVxy8LfmHamuo18vuzRg38YFU7n/sIJnuxwSFj0lR CoEHRE8lbvc9kGP1gwBhS8BnrgAJMCQ+XYXPzzX7u/8uQo1KPIs62BZT4XhXc083gVOd fC7lelDWqakcb0jI9Cq+tCw7G0RzhAWIhodaIIz70l9s9zziFnjrVLwwcMnInaZCIHGa sxnGWsJAeCX/Ir/rlhYQKFyUN7+fIO+orIrSyrEw6/LwtrzsCXg9j3O+SCbXpeu1IpvZ 1IAFtcMxeb7t/IwvSYUaKUoF9l0XhxMLtgHSYy+26ohlZ4PvjBasw965cOlXAdqxh9s+ 0MbQ== 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=jWMh3o5Sz4lobJZSj2jc94Ym//pLheEISSUX45zQ7k4d9O3988G/Fe5+V8jWNUjhOI 5PI9AXQfdumeW6K3EEC2TgLyr6ZIX+2axU/40uLwGLzWarjkNBXOvjB6dA3rkA1+1SBF dQRsUyy8hLOkNLehnRKdX2xDSywCoppkBNSLK9kfmk8U3knsSsCTQsVg+CHDb5ncQNCL U/Fvly0UCmTj2oUtY3gllwc2Cp1Dj2JOHSaGHTMK+rxDjblj7wgKp7v9iKp0OccjI6IV e0ASHTZpj5Jnmex2UnBqtW+dEm8b2tH0l3zCiResrChI+5/u/WeguDS7RuCtIy251rCZ 37Mg== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.129.153 as permitted sender) smtp.mailfrom=Srinuvasan_A@mentor.com Received: from esa1.mentor.iphmx.com (esa1.mentor.iphmx.com. [68.232.129.153]) by gmr-mx.google.com with ESMTPS id pb3-20020a17090b3c0300b0023dbbc039bbsi199013pjb.0.2023.03.29.01.12.20 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 29 Mar 2023 01:12:20 -0700 (PDT) Received-SPF: pass (google.com: domain of srinuvasan_a@mentor.com designates 68.232.129.153 as permitted sender) client-ip=68.232.129.153; X-IronPort-AV: E=Sophos;i="5.98,300,1673942400"; d="scan'208";a="847987" Received: from orw-gwy-01-in.mentorg.com ([192.94.38.165]) by esa1.mentor.iphmx.com with ESMTP; 29 Mar 2023 00:12:19 -0800 IronPort-SDR: gMJBPtX8qy8Jdq9U7BeSaIvj4RMmMa6R/SNsJrxVka5kmJkIeIIhpoEBL89RqbmkX1FP9BP4/f BLbhPOiSTJzr8xCJx5YJrJYghIkfVHxxJtp1zIDs78elkRoG6GrY1qyMqkdFNKh0EKg/px2V8i ZzQtM7ymH2Sttsq0C95tHhDgLh2Org3U6fpe+KkCEgWPRBEuZQAgyM5hJ0s2vNgtRq4F/QQFSF TF04jMsfED1HKeZyVtxesPtEmyS0mrsauodjigAodNn/MqFF8IL+ByjWAgRk+WBE8hZXaoQCDZ cWY= From: Srinuvasan Arjunan To: CC: , Srinuvasan A Subject: [PATCH] doc/user_manual.md: Fix typo Date: Wed, 29 Mar 2023 13:41:52 +0530 Message-ID: <20230329081152.355809-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.129.153 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-Google-Group-Id: 914930254986 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_EF,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,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.