public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: Jan Kiszka <jan.kiszka@siemens.com>
To: isar-users <isar-users@googlegroups.com>
Subject: [PATCH v3 11/16] sdk: Update README.sdk
Date: Tue, 22 Sep 2020 17:28:49 +0200	[thread overview]
Message-ID: <11551cdba375ebeef9fda6523c62387bdd60826a.1600788534.git.jan.kiszka@siemens.com> (raw)
In-Reply-To: <cover.1600788534.git.jan.kiszka@siemens.com>

From: Jan Kiszka <jan.kiszka@siemens.com>

Document the out-of-chroot invocation and make it the preferred option.
Also remove irrelevant information.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 .../sdkchroot/files/README.sdk                | 71 ++++++++++---------
 1 file changed, 36 insertions(+), 35 deletions(-)

diff --git a/meta/recipes-devtools/sdkchroot/files/README.sdk b/meta/recipes-devtools/sdkchroot/files/README.sdk
index 9c1af6d3..3e06d8c5 100644
--- a/meta/recipes-devtools/sdkchroot/files/README.sdk
+++ b/meta/recipes-devtools/sdkchroot/files/README.sdk
@@ -1,42 +1,43 @@
-Building applications for targets in ISAR takes a lot of time as they are built under QEMU.
-SDK helps to develop applications for target platform in crossbuild environment.
+ISAR Target SDK
+===============
 
-SDK contains cross-toolchain for target architecture and a copy of isar-apt repo with
-locally prebuilt target debian packages.
+This SDK helps to develop applications for an ISAR target platform in a
+crossbuild environment. It contains a cross-toolchain and development packages
+corresponding to the original target.
 
- - First one have to mount the system directories for proper operation in chroot environement.
-Just call supplied with sdk tarball  in  udo rootfs as an argument to the script `mount_chroot.sh`:
+The SDK can be used in two ways, described in the following.
 
-$ sudo mount_chroot.sh  <sdk_rootfs>
 
- - chroot to isar SDK rootfs:
+Option 1 (recommended): Use cross-compiler in host environment
+--------------------------------------------------------------
+
+After unpacking the SDK at the desired location, it has to be relocated once:
+
+$ <sdk_rootfs>/relocate-sdk.sh
+
+Now you can add <sdk_rootfs>/usr/bin to the local path or adjust your project
+to call the cross-compiler from the SDK.
+
+
+Option 2 (fallback): Build inside chroot
+----------------------------------------
+
+First you have to mount the system directories for proper operation into the
+chroot environment. Call the helper script supplied with SDK tarball:
+
+$ sudo <sdk_rootfs>/mount_chroot.sh <sdk_rootfs>
+
+Bind-mount the project into the rootfs:
+
+$ sudo mount -o bind /path/to/project <sdk_rootfs>/mnt
+
+If you have relocated the SDK previously for using option 1, you need to call
+this next:
+
+$ <sdk_rootfs>/relocate-sdk.sh --restore-chroot
+
+Then chroot into the SDK rootfs:
 
 $ sudo chroot <sdk_rootfs>
 
- - Check that cross toolchains are installed
-
-:~# dpkg -l | grep crossbuild-essential-armhf
-ii  crossbuild-essential-armhf           12.3                   all          Informational list of cross-build-essential packages
-
- - Install needed prebuilt target packages.
-
-:~# apt-get update
-:~# apt-get install libhello-dev:armhf
-
- - Check the contents of the installed target package
-
-:~# dpkg -L libhello-dev
-/.
-/usr
-/usr/include
-/usr/include/hello.h
-/usr/lib
-/usr/lib/arm-linux-gnueabihf
-/usr/lib/arm-linux-gnueabihf/libhello.a
-/usr/lib/arm-linux-gnueabihf/libhello.la
-/usr/share
-/usr/share/doc
-/usr/share/doc/libhello-dev
-/usr/share/doc/libhello-dev/changelog.gz
-/usr/share/doc/libhello-dev/copyright
-~#
+Now you can build the project under /mnt.
-- 
2.26.2


  parent reply	other threads:[~2020-09-22 15:29 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-22 15:28 [PATCH v3 00/16] Complete backlog: SDK, compat arch, assorting fixed and cleanups Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 01/16] Split up isar-apt into distro-arch specific instances Jan Kiszka
2020-10-06  8:29   ` Baurzhan Ismagulov
2020-09-22 15:28 ` [PATCH v3 02/16] linux-custom: Clean up minor inconsistencies in rules.tmpl Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 03/16] sshd-regen-keys: Issue sync after regeneration Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 04/16] meta-isar: Drop outdated cross-compilation comment Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 05/16] qemuamd64: Fix OVMF path Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 06/16] sdk: Add support for adding self-defined sdk packages Jan Kiszka
2020-09-29 19:15   ` Baurzhan Ismagulov
2020-09-30 19:19     ` Jan Kiszka
2020-10-06  9:00       ` Baurzhan Ismagulov
2020-10-07  7:30         ` Jan Kiszka
2020-10-07  8:06           ` Baurzhan Ismagulov
2020-10-07 13:36             ` Jan Kiszka
2020-10-15 21:51               ` Baurzhan Ismagulov
2020-10-16  7:15                 ` Jan Kiszka
2020-11-01 15:17                   ` Baurzhan Ismagulov
2020-09-22 15:28 ` [PATCH v3 07/16] sdk: Make all links in the SDK chroot relative Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 08/16] sdk: Add script to relocate SDK Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 09/16] sdk: Make shipping the isar-apt repo opt-in Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 10/16] sdk: Inject sysroot path when calling relocated toolchain Jan Kiszka
2020-09-22 15:28 ` Jan Kiszka [this message]
2020-09-22 15:28 ` [PATCH v3 12/16] Add compat architecture support via multiarch Jan Kiszka
2020-09-24 20:19   ` Baurzhan Ismagulov
2020-09-22 15:28 ` [PATCH v3 13/16] ci: Add compat arch support Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 14/16] doc: Enhance list of supported cross-archs, drop QEMU reference Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 15/16] doc: Describe new compat arch support Jan Kiszka
2020-09-22 15:28 ` [PATCH v3 16/16] isar-bootstrap: Connect to gpg-agent before adding keys Jan Kiszka
2020-09-22 21:03   ` Jan Kiszka
2020-09-23 20:29     ` Baurzhan Ismagulov
2020-09-24  9:10       ` [PATCH v4 " Jan Kiszka

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11551cdba375ebeef9fda6523c62387bdd60826a.1600788534.git.jan.kiszka@siemens.com \
    --to=jan.kiszka@siemens.com \
    --cc=isar-users@googlegroups.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox