summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuergen Borleis <jbe@pengutronix.de>2016-06-20 13:04:29 +0200
committerMichael Olbrich <m.olbrich@pengutronix.de>2016-06-20 15:05:05 +0200
commit566b01cd5622ec9abffdb7e6724a91c7f96a7a19 (patch)
treedd32d83eaab753629e72bd9259315b8fdffe5c67
parentc9bc7660cb4fb17c57f16e82a86f034652299993 (diff)
downloadptxdist-566b01cd5622ec9abffdb7e6724a91c7f96a7a19.tar.gz
Keep this string verbatim to use it everywhere
Adapt this variable to the same manner as all other variables as well. This ensures we can use them everywhere we want and can define the visible layout locally where we use it. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
-rw-r--r--doc/conf.py2
-rw-r--r--doc/daily_work.inc8
-rw-r--r--doc/user_manual.inc24
3 files changed, 17 insertions, 17 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 1fa5bbb..417e149 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -106,7 +106,7 @@ try:
except:
toolchain = "/opt/OSELAS.Toolchain-2014.12.2/arm-v5te-linux-gnueabi/gcc-4.9.2-glibc-2.20-binutils-2.24-kernel-3.16-sanitized/bin".split("/")
-ptxdistPlatformDir = "``platform-" + os.getenv("PTXCONF_PLATFORM", "versatilepb") + "``"
+ptxdistPlatformDir = "platform-" + os.getenv("PTXCONF_PLATFORM", "versatilepb")
oselasTCNarch = gnu_target.split("-")[0]
oselasTCNvariant = gnu_target.split("-")[1]
oselasTCNVendorVersion = toolchain[-4].split("-")[1]
diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index 8f9f88c..bbde223 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -225,8 +225,8 @@ With this preparation we can run it on our build host:
::
- $ cd platform-<platformname>/root
- platform-<platformname>/root$ qemu-<architecture> -cpu <cpu-core> -L . usr/bin/myapp
+ $ cd |ptxdistPlatformDir|/root
+ |ptxdistPlatformDir|/root$ qemu-<architecture> -cpu <cpu-core> -L . usr/bin/myapp
This command will run the application ``usr/bin/myapp`` built for an
<cpu-core> CPU on the build host and is using all library compontents
@@ -251,8 +251,8 @@ the QEMU in the first console as:
::
- $ cd platform-<platformname>/root-debug
- platform-<platformname>/root-debug$ qemu-<architecture> -g 1234 -cpu <cpu-core> -L . usr/bin/myapp
+ $ cd ptxdistPlatformDir/root-debug
+ ptxdistPlatformDir/root-debug$ qemu-<architecture> -g 1234 -cpu <cpu-core> -L . usr/bin/myapp
.. note:: PTXdist always builds two root filesystems. ``root/`` and
``root-debug/``. ``root/`` contains all components without debug
diff --git a/doc/user_manual.inc b/doc/user_manual.inc
index 612c318..626ad85 100644
--- a/doc/user_manual.inc
+++ b/doc/user_manual.inc
@@ -383,40 +383,39 @@ What we Got Now
After building the project, we find even more sub directories in our
project.
-|ptxdistPlatformDir|\ ``/build-cross``
+``|ptxdistPlatformDir|/build-cross``
Contains all packages sources compiled to run on the host and handle
target architecture dependend things.
-|ptxdistPlatformDir|\ ``/build-host``
+``|ptxdistPlatformDir|/build-host``
Contains all packages sources compiled to run on the host and handle
architecture independend things.
-|ptxdistPlatformDir|\ ``/build-target``
+``|ptxdistPlatformDir|/build-target``
Contains all package sources compiled for the target architecure.
-|ptxdistPlatformDir|\ ``/images``
+``|ptxdistPlatformDir|/images``
Generated files for the target can be found here: Kernel image and
root filesystem image.
-|ptxdistPlatformDir|\ ``/packages``
+``|ptxdistPlatformDir|/packages``
Location for alle individual packages in ipk format.
-|ptxdistPlatformDir|\ ``/sysroot-target``
+``|ptxdistPlatformDir|/sysroot-target``
Contains everything target architecture dependend (libraries, header
files and so on).
-|ptxdistPlatformDir|\ ``/sysroot-cross``
+``|ptxdistPlatformDir|/sysroot-cross``
Contains everything that is host specific but must handle target
architecture data.
-|ptxdistPlatformDir|\ ``/sysroot-host``
+``|ptxdistPlatformDir|/sysroot-host``
Contains everything that is only host specific.
-|ptxdistPlatformDir|\ ``/root``
+``|ptxdistPlatformDir|/root``
Target’s root filesystem image. This directory can be mounted as
an NFS root for example.
-|ptxdistPlatformDir|\ ``/root-debug``
Target’s root filesystem image. The difference to ``root/`` is,
all programs and libraries in this directory still have their
debug information present. This directory is intended to be used
@@ -424,7 +423,8 @@ project.
should setup your debugger with
``set solib-absolute-prefix </path/to/workspace>/root-debug``
-|ptxdistPlatformDir|\ ``/state``
+``|ptxdistPlatformDir|/root-debug``
+``|ptxdistPlatformDir|/state``
Building every package is divided onto stages. And stages of one
package can depend on stages of other packages. In order to handle
this correctly, this directory contains timestamp files about
@@ -432,6 +432,6 @@ project.
And one important file in case of trouble:
-|ptxdistPlatformDir|\ ``/logfile``
+``|ptxdistPlatformDir|/logfile``
Every run of PTXdist will add its output to this file. If something
fails, this file can help to find the cause.