Re: [ptxdist] [APPLIED] doc: conf.py: replace 'versatilepb' with example placeholder

[Michael Olbrich <m.olbrich@pengutronix.de>]

Thanks, applied as 8c01cc58de694e420d21949c74bc2eecc14b5828.

Michael

[sent from post-receive hook]

On Thu, 12 Sep 2024 14:11:38 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> 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>
> Message-Id: <20240808094035.1636229-3-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> 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>"