mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [ptxdist] [PATCH 3/4] doc: conf.py: replace 'versatilepb' with example placeholder
Date: Thu,  8 Aug 2024 11:40:34 +0200	[thread overview]
Message-ID: <20240808094035.1636229-3-rhi@pengutronix.de> (raw)
In-Reply-To: <20240808094035.1636229-1-rhi@pengutronix.de>

The platform is the last placeholder referring to a specific name, which
regularly seems to confuse people that are new to PTXdist. Replace it by
a more expressive placeholder marking its example status, unless a more
specific platform name can be used from PTXCONF_PLATFORM.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/conf.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 49d19965f8e8..b1a6fe3293b6 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -114,7 +114,7 @@ try:
 except:
 	toolchain = "/opt/OSELAS.Toolchain-2022.10.0/arm-v7a-linux-gnueabihf/gcc-12.2.1-clang-15.0.2-glibc-2.36-binutils-2.39-kernel-6.0.5-sanitized/bin".split("/")
 
-ptxdistPlatformName = os.getenv("PTXCONF_PLATFORM", "versatilepb")
+ptxdistPlatformName = os.getenv("PTXCONF_PLATFORM", "example")
 ptxdistPlatformDir = "platform-" + ptxdistPlatformName
 oselasTCNarch = gnu_target.split("-")[0]
 oselasTCNvariant = gnu_target.split("-")[1]
@@ -127,7 +127,7 @@ ptxdistBSPName = "OSELAS.BSP-" + ptxdistHwVendor + "-" + ptxdistHwProduct + os.g
 ptxdistBSPRevision = os.getenv("PTXDIST_BSP_AUTOVERSION", "???")
 ptxdistCompilerName = gnu_target
 ptxdistCompilerVersion = toolchain[-2]
-ptxdistPlatformConfigDir = os.path.basename(os.getenv("PTXDIST_PLATFORMCONFIGDIR")) if os.getenv("PTXDIST_PLATFORMCONFIGDIR") != os.getenv("PTXDIST_TOPDIR") else "platform-versatilepb"
+ptxdistPlatformConfigDir = os.path.basename(os.getenv("PTXDIST_PLATFORMCONFIGDIR")) if os.getenv("PTXDIST_PLATFORMCONFIGDIR") != os.getenv("PTXDIST_TOPDIR") else "platform-<example>"
 ptxdistPlatformCollection = "\ "
 ptxdistVendorVersion = os.getenv("PTXDIST_VERSION_YEAR") + "." + os.getenv("PTXDIST_VERSION_MONTH") + "." + os.getenv("PTXDIST_VERSION_BUGFIX")
 package = "<package>"
-- 
2.39.2




  parent reply	other threads:[~2024-08-08  9:41 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-08  9:40 [ptxdist] [PATCH 1/4] doc: ref_make_macros: improve world/image-clean documentation Roland Hieber
2024-08-08  9:40 ` [ptxdist] [PATCH 2/4] docs: ref_rule_file_layout: document default clean stage Roland Hieber
2024-09-12 12:11   ` [ptxdist] [APPLIED] " Michael Olbrich
2024-08-08  9:40 ` Roland Hieber [this message]
2024-09-12 12:11   ` [ptxdist] [APPLIED] doc: conf.py: replace 'versatilepb' with example placeholder Michael Olbrich
2024-08-08  9:40 ` [ptxdist] [PATCH 4/4] doc: conf.py: update default toolchain version Roland Hieber
2024-09-12 12:11   ` [ptxdist] [APPLIED] " Michael Olbrich
2024-09-12 12:11 ` [ptxdist] [APPLIED] doc: ref_make_macros: improve world/image-clean documentation Michael Olbrich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240808094035.1636229-3-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox