Template:EcosystemRelease/Components: Difference between revisions

Latest revision as of 17:53, 25 June 2024↑

1. Usage[edit source]↑

The EcosystemRelease/Components template returns the version of all software components delivered by an ecosystem release revision of the flow associated with this wiki (e.g. v1.y.z ,or v2.y.z, or...).

Usage: {{EcosystemRelease/Components | revision=<revision>}}

Where:

<revision> is the mandatory revision of the ecosystem release, for which the version of all software components is requested.
- The possible values for this parameter are available in the EcosystemRelease/Revision template.

Important

Use the value latest for <revision> with caution: be aware that the returned string will vary depending on the latest ecosystem release.

The returned value is:

a string that contains the version of all the main software components delivered by the ecosystem release revision , in a form that is usable by a tooltip. "Main software components" means software components visible into the architecture top diagram.
"unknown revision", if <revision> is not supported.

This template relies on the EcosystemRelease/Component template.

2. Basic examples[edit source]↑

You type	You get
Components version for the latest revision requested {{EcosystemRelease/Components \| revision=latest}}	Main software components: unknown revision unknown revision unknown revision unknown revision unknown revision unknown revision unknown revision
Components version for v5.1.0 revision requested {{EcosystemRelease/Components \| revision=5.1.0}}	Main software components: unknown revision
Components version for v5.0.0 revision requested {{EcosystemRelease/Components \| revision=5.0.0}}	Main software components: unknown revision
Components version for v4.1.0 revision requested {{EcosystemRelease/Components \| revision=4.1.0}}	Main software components: unknown revision

3. More examples[edit source]↑

You type	You get
Components version for vx.0.0 revision (legacy) requested {{EcosystemRelease/Components \| revision=x.0.0}}	Main software components: Linux kernel vx.y (example) U-Boot vx.y (example) TF-A vx.y (example) OP-TEE vx.y (example) STM32CubeMP1 Package vx.y (example) OpenEmbedded vx.y (example)
Components version for vx.1.0 revision (latest) requested {{EcosystemRelease/Components \| revision=x.1.0}}	Main software components: Linux kernel vx.y (example) U-Boot vx.y (example) TF-A vx.y (example) OP-TEE vx.y (example) STM32CubeMP1 Package vx.y (example) OpenEmbedded vx.y (example) Android vx.y (example)
Components version for vx.2.0 revision (next) requested {{EcosystemRelease/Components \| revision=x.2.0}}	Main software components: Linux kernel vx.y (example) U-Boot vx.y (example) TF-A vx.y (example) OP-TEE vx.y (example) STM32CubeMP1 Package vx.y (example) OpenEmbedded vx.y (example) Android vx.y (example)
Components version for v0.y.0 revision (former) requested {{EcosystemRelease/Components \| revision=0.y.0}}	Main software components: unknown revision unknown revision unknown revision unknown revision unknown revision unknown revision unknown revision
Unspecified revision {{EcosystemRelease/Components}}	Main software components: unknown revision
Unknown revision {{EcosystemRelease/Components \| revision=10.20.30}}	Main software components: unknown revision

4. Code[edit source]↑

Main software components: unknown revision

@@ Line 1: / Line 1: @@
 <noinclude>
+{{ReviewsComments|-- [[User:Nathalie Sangouard|Nathalie Sangouard]] ([[User talk:Nathalie Sangouard|talk]]) 18:11, 24 June 2024 (CEST)<br />should we add in this template the stm32-ddr-phy-binary aka DDR firmware ?}}
+{{ReviewsComments|-- [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 17:50, 25 June 2024 (CEST)<br />To me, no because "components" are only the ones identified in [[STM32MPU_Embedded_Software_architecture_overview]]}}
 ==Usage==
 The [[Template:EcosystemRelease/Components|EcosystemRelease/Components]] template returns '''the version of all software components''' delivered by an ecosystem release revision of the flow associated with this wiki (e.g. v1.y.z ,or v2.y.z, or...).
   Usage: <nowiki>{{</nowiki>EcosystemRelease/Components | revision={{HighlightParam|<revision>}}}}
 Where:
 * {{HighlightParam|<revision>}} is the '''mandatory''' revision of the ecosystem release, for which the version of all  software components is requested.
 ** The possible values for this parameter are available in the [[Template:EcosystemRelease/Revision|EcosystemRelease/Revision]] template.
+{{Important | Use the value '''latest''' for {{HighlightParam|<revision>}} with caution: be aware that the returned string will vary depending on the latest ecosystem release.}}
 The returned value is:
-* a string that contains the version of all the software components delivered by the ecosystem release revision, in a form that is usable by a tooltip.
+* a string that contains the version of all the '''main''' software components delivered by the ecosystem release revision  , in a form that is usable by a tooltip. "Main software components" means software components visible into the architecture top diagram.
 * "unknown revision", if {{HighlightParam|<revision>}} is not supported.
@@ Line 18: / Line 24: @@
 ! style="width: 50%;" | You type !! You get
 |-
-| Components version for vx.0.0 revision requested
+| Components version for the latest revision requested
 <pre style="white-space: pre-wrap;">
-{{EcosystemRelease/Components | revision=x.0.0}}
+{{EcosystemRelease/Components | revision=latest}}
 </pre>
 |
-{{EcosystemRelease/Components | revision=x.0.0}}
+{{EcosystemRelease/Components | revision=latest}}
 |-
-| Components version for v3.0.0 revision requested
+| Components version for v5.1.0 revision requested
 <pre style="white-space: pre-wrap;">
-{{EcosystemRelease/Components | revision=3.0.0}}
+{{EcosystemRelease/Components | revision=5.1.0}}
 </pre>
 |
-{{EcosystemRelease/Components | revision=3.0.0}}
+{{EcosystemRelease/Components | revision=5.1.0}}
 |-
-| Components version for v3.1.0 revision requested
+| Components version for v5.0.0 revision requested
 <pre style="white-space: pre-wrap;">
-{{EcosystemRelease/Components | revision=3.1.0}}
+{{EcosystemRelease/Components | revision=5.0.0}}
 </pre>
 |
-{{EcosystemRelease/Components | revision=3.1.0}}
+{{EcosystemRelease/Components | revision=5.0.0}}
 |-
-| Components version for v3.1.0.ALPHA revision requested
+| Components version for v4.1.0 revision requested
 <pre style="white-space: pre-wrap;">
-{{EcosystemRelease/Components | revision=3.1.0.ALPHA }}
+{{EcosystemRelease/Components | revision=4.1.0}}
 </pre>
 |
-{{EcosystemRelease/Components | revision=3.1.0.ALPHA }}
+{{EcosystemRelease/Components | revision=4.1.0}}
 |}
@@ Line 51: / Line 57: @@
 ! style="width: 50%;" | You type !! You get
 |-
-| Components version for vx.2.0 revision requested
+| Components version for vx.0.0 revision (legacy) requested
+<pre style="white-space: pre-wrap;">
+{{EcosystemRelease/Components | revision=x.0.0}}
+</pre>
+|
+{{EcosystemRelease/Components | revision=x.0.0}}
+|-
+| Components version for vx.1.0 revision (latest) requested
+<pre style="white-space: pre-wrap;">
+{{EcosystemRelease/Components | revision=x.1.0}}
+</pre>
+|
+{{EcosystemRelease/Components | revision=x.1.0}}
+|-
+| Components version for vx.2.0 revision (next) requested
 <pre style="white-space: pre-wrap;">
 {{EcosystemRelease/Components | revision=x.2.0}}
@@ Line 58: / Line 78: @@
 {{EcosystemRelease/Components | revision=x.2.0}}
 |-
-| Components version for vx.1.0 revision requested
+| Components version for v0.y.0 revision (former) requested
 <pre style="white-space: pre-wrap;">
-{{EcosystemRelease/Components | revision=x.1.0}}
+{{EcosystemRelease/Components | revision=0.y.0}}
 </pre>
 |
-{{EcosystemRelease/Components | revision=x.1.0}}
+{{EcosystemRelease/Components | revision=0.y.0}}
 |-
 | Unspecified revision
@@ Line 83: / Line 103: @@
 </noinclude>Main software components:&#10;{{#switch: {{EcosystemRelease/Revision| revision={{{revision|}}}}}
 | unknown = {{Highlight|unknown revision}}
-| #default = {{EcosystemRelease/Component | revision={{{revision|}}} | component=Linux kernel}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=U-Boot}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=TF-A}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=OP-TEE}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=STM32CubeMPU}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=OpenEmbedded}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=Android}}
+| #default = {{#vardefine:STM32CubeMP2|{{EcosystemRelease/Component | revision={{{revision|}}} | component=STM32CubeMP2}}}}{{#vardefine:TF-M|{{EcosystemRelease/Component | revision={{{revision|}}} | component=TF-M}}}}{{EcosystemRelease/Component | revision={{{revision|}}} | component=Linux kernel}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=U-Boot}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=TF-A}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=OP-TEE}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=STM32CubeMP1}}&#10;{{#if: {{#var:STM32CubeMP2}} | {{#var:STM32CubeMP2}}&#10; | }}{{#if: {{#var:TF-M}} | {{#var:TF-M}}&#10; | }}{{EcosystemRelease/Component | revision={{{revision|}}} | component=OpenEmbedded}}&#10;{{EcosystemRelease/Component | revision={{{revision|}}} | component=Android}}
 }}