diff options
| author | Michael Olbrich <m.olbrich@pengutronix.de> | 2016-06-20 11:35:06 +0200 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2016-06-20 15:04:58 +0200 |
| commit | 7906f37d9c7914037da1e2cfaa69955b1a22c5e8 (patch) | |
| tree | 1bc5f4e702a83c9304230558a3b5759d77c3714c | |
| parent | 185c2bebaa1686f2faacca62fca24be1c6909163 (diff) | |
| download | ptxdist-7906f37d9c7914037da1e2cfaa69955b1a22c5e8.tar.gz ptxdist-7906f37d9c7914037da1e2cfaa69955b1a22c5e8.tar.xz | |
docs: use better variable name for the platform config directory
The directory containing the platformconfig is called platformconfigdir in
ptxdist. Name the variable accordingly and set the default value correctly.
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
| -rw-r--r-- | doc/conf.py | 4 | ||||
| -rw-r--r-- | doc/dev_manual.rst | 4 | ||||
| -rw-r--r-- | doc/user_manual.inc | 4 |
3 files changed, 6 insertions, 6 deletions
diff --git a/doc/conf.py b/doc/conf.py index fe3530549..1fa5bbb62 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -115,7 +115,7 @@ oselasToolchainName = toolchain[-3] + "_" + re.sub(r"-([a-z])",r"_\1", toolchain ptxdistBSPName = "OSELAS.BSP-" + os.getenv("PTXCONF_PROJECT_VENDOR", "Pengutronix") + "-" + os.getenv("PTXCONF_PROJECT", "Example") + os.getenv("PTXCONF_PROJECT_VERSION", "") ptxdistCompilerName = gnu_target ptxdistCompilerVersion = toolchain[-2] -ptxdistPlatformName = "platform-" + os.getenv("PTXCONF_PLATFORM", "versatilepb") +ptxdistPlatformConfigDir = os.path.basename(os.getenv("PTXDIST_PLATFORMCONFIGDIR")) if os.getenv("PTXDIST_PLATFORMCONFIGDIR") != os.getenv("PTXDIST_TOPDIR") else "platform-versatilepb" ptxdistPlatformCollection = "\ " ptxdistVendorVersion = os.getenv("PTXDIST_VERSION_YEAR") + "." + os.getenv("PTXDIST_VERSION_MONTH") + "." + os.getenv("PTXDIST_VERSION_BUGFIX") package = "<package>" @@ -136,7 +136,7 @@ replace_dict = { b"|ptxdistBSPName|": ptxdistBSPName, b"|ptxdistCompilerName|": ptxdistCompilerName, b"|ptxdistCompilerVersion|": ptxdistCompilerVersion, - b"|ptxdistPlatformName|": ptxdistPlatformName, + b"|ptxdistPlatformConfigDir|": ptxdistPlatformConfigDir, b"|ptxdistPlatformCollection|": ptxdistPlatformCollection, b"|ptxdistVendorVersion|": ptxdistVendorVersion, b"|package|": package diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst index 70099b266..4bd22be1b 100644 --- a/doc/dev_manual.rst +++ b/doc/dev_manual.rst @@ -67,7 +67,7 @@ package in question. One location is the project’s currently used platform directory. If the currently used platform is located in ``configs/``, PTXdist searches in -./configs/|ptxdistPlatformName|/patches/<package name> +./configs/|ptxdistPlatformConfigDir|/patches/<package name> If no patch series was found in the platform directory, the next location PTXdist it searches for a patch series is the main project @@ -1098,7 +1098,7 @@ for patches in: #. project (``./patches/foo-1.1.0``) -#. platform (``./configs/|ptxdistPlatformName|/patches/foo-1.1.0``) +#. platform (``./configs/|ptxdistPlatformConfigDir|/patches/foo-1.1.0``) #. ptxdist (``<ptxdist/installation/path>/patches/foo-1.1.0``) diff --git a/doc/user_manual.inc b/doc/user_manual.inc index d5f5dca18..612c3183e 100644 --- a/doc/user_manual.inc +++ b/doc/user_manual.inc @@ -332,9 +332,9 @@ platforms to build for. In this case we want to build for the : :: - $ ptxdist platform configs/|ptxdistPlatformName|/platformconfig + $ ptxdist platform configs/|ptxdistPlatformConfigDir|/platformconfig info: selected platformconfig: - 'configs/|ptxdistPlatformName|/platformconfig' + 'configs/|ptxdistPlatformConfigDir|/platformconfig' .. note:: If you have installed the OSELAS.Toolchain() at its default location, PTXdist should already have detected the proper toolchain |