Skip to contentSkip to conversation

docs/manual/quickstart: Mention sysroot dir.

PATCH New Michael Drake 2 participants 2 messages Nov 15, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/manual/quickstart: Mention sysroot dir.

Mention that staging/ is a symlink to the host/$(GNU_TARGET_NAME)/sysroot directory.

---
 docs/manual/quickstart.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
docs/manual/quickstart.txt +2 -1
index 74158ae249..d9bbc2527b 100644
@@ -95,7 +95,8 @@ This directory contains several subdirectories:
   files, unstripped binaries and libraries that make it far too big
   for an embedded system. These development files are used to compile
   libraries and applications for the target that depend on other
-  libraries.
+  libraries. +staging/+ is actually a symlink to the toolchain's target
+  sysroot directory inside +host/+.
 
 * +target/+ which contains 'almost' the complete root filesystem for
   the target: everything needed is present except the device files in
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/1 docs/manual/quickstart: Mention sysroot dir.

Hello Michael,

Thanks for your contribution!

Quoted 2 lines · On Fri, 15 Nov 2019 12:10:22 +0000 Michael Drake…

Mention that staging/ is a symlink to the host/$(GNU_TARGET_NAME)/sysroot directory.

We need your Signed-off-by line here, to be able to apply your patch. However ...

Quoted 9 lines
---
 docs/manual/quickstart.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
docs/manual/quickstart.txt +0 -0
index 74158ae249..d9bbc2527b 100644

docs/manual/quickstart.txt This directory contains several subdirectories: · line 99

Quoted 6 lines
docs/manual/quickstart.txt +2 -1
@@ -95,7 +95,8 @@ This directory contains several subdirectories:
   files, unstripped binaries and libraries that make it far too big
   for an embedded system. These development files are used to compile
   libraries and applications for the target that depend on other
-  libraries.
+  libraries. +staging/+ is actually a symlink to the toolchain's target
+  sysroot directory inside +host/+.

... I think this section needs a much better overhaul. We want to extend the description of the "host" directory to mention that it contains both the tools built for the host *and* the sysroot of the compiler (possibly reusing the wording of the current staging directory). And this "host" directory should be documented before "staging".

And then, the description for staging should be simplified to just say it's a backward compatibility symlink pointing to the target toolchain sysroot in host/.

Thanks!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com