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 v4 06/13] sdk: Update README.sdk
Date: Wed,  7 Oct 2020 16:01:23 +0200	[thread overview]
Message-ID: <6b3b4b469b32c896f029397f6e0d5b7d62fce65e.1602079290.git.jan.kiszka@siemens.com> (raw)
In-Reply-To: <cover.1602079290.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-10-07 14:01 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-07 14:01 [PATCH v4 00/13] Complete backlog: SDK, assorting fixed and cleanups Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 01/13] sdk: Add support for adding self-defined sdk packages Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 02/13] sdk: Make all links in the SDK chroot relative Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 03/13] sdk: Add script to relocate SDK Jan Kiszka
2020-10-15 18:50   ` Baurzhan Ismagulov
2020-10-16  6:47     ` Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 04/13] sdk: Make shipping the isar-apt repo opt-in Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 05/13] sdk: Inject sysroot path when calling relocated toolchain Jan Kiszka
2020-10-07 14:01 ` Jan Kiszka [this message]
2020-10-16  8:18   ` [PATCH v5 06/13] sdk: Update README.sdk Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 07/13] isar-bootstrap: Connect to gpg-agent before adding keys Jan Kiszka
2020-11-21  7:41   ` Jan Kiszka
2020-12-14  7:03     ` Jan Kiszka
2020-12-16 11:36     ` Baurzhan Ismagulov
2020-12-16 15:53     ` [PATCH v1] isar-bootstrap: Run gpg-agent before starting apt-key Baurzhan Ismagulov
2020-12-16 16:41       ` Jan Kiszka
2021-01-18 17:30         ` Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 08/13] buildchroot-host: Drop unneeded :native for riscv64 setup Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 09/13] deb-dl-dir: Fix quoting Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 10/13] Fix dependencies on isar-apt Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 11/13] dpkg: Account for changes in mk-build-deps in bullseye Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 12/13] isar-bootstrap: Align debootstrap calls Jan Kiszka
2020-10-07 14:01 ` [PATCH v4 13/13] u-boot: Deprecate BUILD_DEPENDS in favor of DEBIAN_BUILD_DEPENDS Jan Kiszka
2020-11-05 14:23 ` [PATCH v4 00/13] Complete backlog: SDK, assorting fixed and cleanups Baurzhan Ismagulov
2020-11-26 15:40 ` Anton Mikanovich

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=6b3b4b469b32c896f029397f6e0d5b7d62fce65e.1602079290.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