Re: [PATCH 1/2] dt-bindings: arm: rockchip: Correct the descriptions for Radxa boards

From: Dragan Simic
Date: Thu Apr 18 2024 - 13:13:09 EST


On 2024-04-18 19:04, Conor Dooley wrote:
On Thu, Apr 18, 2024 at 06:59:42PM +0200, Heiko Stübner wrote:
Am Donnerstag, 18. April 2024, 18:26:19 CEST schrieb Dragan Simic:
> Correct the descriptions of a few Radxa boards, according to the up-to-date
> documentation from Radxa and the detailed explanation from Naoki. [1] To sum
> it up, the short naming, as specified by Radxa, is preferred.
>
> [1] https://lore.kernel.org/linux-rockchip/B26C732A4DCEA9B3+282b8775-601b-4d4a-a513-4924b7940076@xxxxxxxxx/
>
> Suggested-by: FUKAUMI Naoki <naoki@xxxxxxxxx>
> Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
> ---
> Documentation/devicetree/bindings/arm/rockchip.yaml | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/arm/rockchip.yaml b/Documentation/devicetree/bindings/arm/rockchip.yaml
> index fcf7316ecd74..ae58e25c29ec 100644
> --- a/Documentation/devicetree/bindings/arm/rockchip.yaml
> +++ b/Documentation/devicetree/bindings/arm/rockchip.yaml
> @@ -767,22 +767,22 @@ properties:
> - const: radxa,rockpis
> - const: rockchip,rk3308
>
> - - description: Radxa Rock2 Square
> + - description: Radxa Rock 2 Square

I may be just blind, but what changed here?

There's now a space before the 2.

Exactly. That's part of the Radxa's naming convention, which may be
seen as somewhat similar to the general rule of spacing out values and
their associated units, e.g. "2 MB" is in general preferred over "2MB"
in nearly any kind of a formally correct document.

As a side note, there's even so-called "half space" as a typographical
convention for spacing out the values and the associated units. That
makes formatted text with such spacing a bit nicer. :)