diff options
| author | Juergen Borleis <jbe@pengutronix.de> | 2015-06-04 16:26:28 +0200 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2015-12-03 22:37:00 +0100 |
| commit | 42af823451b8efb83344b914f3a9c267ea851ab3 (patch) | |
| tree | 8319a4db748b25e52b4cb17df461ada48c2ea98c | |
| parent | c026d38030ce716eb943dbd8368d3dff2dc86136 (diff) | |
| download | ptxdist-42af823451b8efb83344b914f3a9c267ea851ab3.tar.gz ptxdist-42af823451b8efb83344b914f3a9c267ea851ab3.tar.xz | |
Reference manual: make it more clear what's meant
Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
| -rw-r--r-- | doc/ref_manual.rst | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst index 4167ada29..7bb54a519 100644 --- a/doc/ref_manual.rst +++ b/doc/ref_manual.rst @@ -145,15 +145,17 @@ its regular rules which one it prefers. Many paths shown here contains some parts in angle brackets. These have special meanings in this document. -<platform> - The name of a platform. -<platform-src> - The directory where the platform is defined -<platform-dir> +**<platform>** + The name of a platform. Corresponds to the variable + ``PTXCONF_PLATFORM`` +**<platform-src>** + The directory where the platform is defined. Corresponds to the variable + ``PTXDIST_PLATFORMCONFIGDIR`` +**<platform-dir>** Concatenated directory name with a leading *platform-* and the name of the selected platform name, e.g. <platform>. If the name of the currently active platform is *foo*, the final directory name is *platform-foo*. - + Corresponds to the variable ``PTXDIST_PLATFORMDIR`` .. note:: The list of supported macros is not complete yet. |