summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAhmad Fatoum <a.fatoum@pengutronix.de>2018-10-09 11:11:55 +0200
committerMichael Olbrich <m.olbrich@pengutronix.de>2018-10-09 14:38:04 +0200
commitc3a1afad840104aa2c9ec23fbbbc9ab8a66e7234 (patch)
treeb4de734389b220b157a069c07192e2c770005795 /doc
parentb7a6b838cdd86256d60f1fd05476049d20cc9fef (diff)
downloadptxdist-c3a1afad840104aa2c9ec23fbbbc9ab8a66e7234.tar.gz
ptxdist-c3a1afad840104aa2c9ec23fbbbc9ab8a66e7234.tar.xz
doc: user_manual: use |ptxdist{BSP, Platform}Name| where appropriate
Suggested-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py4
-rw-r--r--doc/user_manual.inc7
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 4a47d8159..1424c4511 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -106,7 +106,8 @@ try:
except:
toolchain = "/opt/OSELAS.Toolchain-2016.06.1/arm-v5te-linux-gnueabi/gcc-5.4.0-glibc-2.23-binutils-2.26-kernel-4.6-sanitized/bin".split("/")
-ptxdistPlatformDir = "platform-" + os.getenv("PTXCONF_PLATFORM", "versatilepb")
+ptxdistPlatformName = os.getenv("PTXCONF_PLATFORM", "versatilepb")
+ptxdistPlatformDir = "platform-" + ptxdistPlatformName
oselasTCNarch = gnu_target.split("-")[0]
oselasTCNvariant = gnu_target.split("-")[1]
oselasTCNVendorVersion = toolchain[-4].split("-")[1]
@@ -130,6 +131,7 @@ except:
pass
replace_dict = {
+ b"|ptxdistPlatformName|": ptxdistPlatformName,
b"|ptxdistPlatformDir|": ptxdistPlatformDir,
b"|oselasTCNarch|": oselasTCNarch,
b"|oselasTCNvariant|": oselasTCNvariant,
diff --git a/doc/user_manual.inc b/doc/user_manual.inc
index e41995782..9f78f5b46 100644
--- a/doc/user_manual.inc
+++ b/doc/user_manual.inc
@@ -316,8 +316,8 @@ Selecting a Userland Configuration
First of all we have to select a userland configuration. This step
defines what kind of applications will be built for the hardware
-platform. The comes with a predefined configuration we select in the
-following step:
+platform. The |ptxdistBSPName| project comes
+with a predefined configuration we select in the following step:
::
@@ -329,7 +329,8 @@ Selecting a Hardware Platform
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Before we can build this BSP, we need to select one of the possible
-platforms to build for. In this case we want to build for the :
+platforms to build for. In this case we want to build for the
+|ptxdistPlatformName|:
::