2022-08-15 09:53:24

by Martin Liška

[permalink] [raw]
Subject: [PATCH] docs/arm64: elf_hwcaps: Unify HWCAP lists as description lists

Extends what was changed in 94bdaa7d9a9d778d893c670d494c06d8e007c1cd.

Add a series of blank lines to this document to get consistend rendering as
an RST description list.

Signed-off-by: Martin Liska <[email protected]>
---
Documentation/arm64/elf_hwcaps.rst | 10 ----------
1 file changed, 10 deletions(-)

diff --git a/Documentation/arm64/elf_hwcaps.rst b/Documentation/arm64/elf_hwcaps.rst
index 52b75a25c205..311021f2e560 100644
--- a/Documentation/arm64/elf_hwcaps.rst
+++ b/Documentation/arm64/elf_hwcaps.rst
@@ -242,44 +242,34 @@ HWCAP2_MTE3
by Documentation/arm64/memory-tagging-extension.rst.

HWCAP2_SME
-
Functionality implied by ID_AA64PFR1_EL1.SME == 0b0001, as described
by Documentation/arm64/sme.rst.

HWCAP2_SME_I16I64
-
Functionality implied by ID_AA64SMFR0_EL1.I16I64 == 0b1111.

HWCAP2_SME_F64F64
-
Functionality implied by ID_AA64SMFR0_EL1.F64F64 == 0b1.

HWCAP2_SME_I8I32
-
Functionality implied by ID_AA64SMFR0_EL1.I8I32 == 0b1111.

HWCAP2_SME_F16F32
-
Functionality implied by ID_AA64SMFR0_EL1.F16F32 == 0b1.

HWCAP2_SME_B16F32
-
Functionality implied by ID_AA64SMFR0_EL1.B16F32 == 0b1.

HWCAP2_SME_F32F32
-
Functionality implied by ID_AA64SMFR0_EL1.F32F32 == 0b1.

HWCAP2_SME_FA64
-
Functionality implied by ID_AA64SMFR0_EL1.FA64 == 0b1.

HWCAP2_WFXT
-
Functionality implied by ID_AA64ISAR2_EL1.WFXT == 0b0010.

HWCAP2_EBF16
-
Functionality implied by ID_AA64ISAR1_EL1.BF16 == 0b0010.

4. Unused AT_HWCAP bits
--
2.37.1


2022-08-15 13:43:05

by Mark Brown

[permalink] [raw]
Subject: Re: [PATCH] docs/arm64: elf_hwcaps: Unify HWCAP lists as description lists

On Mon, Aug 15, 2022 at 11:19:40AM +0200, Martin Liška wrote:
> Extends what was changed in 94bdaa7d9a9d778d893c670d494c06d8e007c1cd.

For those playing at home that's "docs/arm64: elf_hwcaps: Unify HWCAP
lists as description lists".

Please include human readable descriptions of things like commits and
issues being discussed in e-mail in your mails, this makes them much
easier for humans to read.

> Add a series of blank lines to this document to get consistend rendering as
> an RST description list.

The commit message says that this is adding blank lines but...

> by Documentation/arm64/memory-tagging-extension.rst.
>
> HWCAP2_SME
> -
> Functionality implied by ID_AA64PFR1_EL1.SME == 0b0001, as described
> by Documentation/arm64/sme.rst.

...the actual patch is deleting them?


Attachments:
(No filename) (832.00 B)
signature.asc (499.00 B)
Download all attachments

2022-08-15 13:46:10

by Martin Liška

[permalink] [raw]
Subject: [PATCH v2] docs/arm64: elf_hwcaps: unify newlines in HWCAP lists

In git revision 94bdaa7d9a9d778d893c670d494c06d8e007c1cd I unified
vertical spaces in a list of features.

Since the revision, another commits added new features that have a different
horizontal spacing.
Fix these extra newlines.

Signed-off-by: Martin Liska <[email protected]>
---
Documentation/arm64/elf_hwcaps.rst | 10 ----------
1 file changed, 10 deletions(-)

diff --git a/Documentation/arm64/elf_hwcaps.rst b/Documentation/arm64/elf_hwcaps.rst
index 52b75a25c205..311021f2e560 100644
--- a/Documentation/arm64/elf_hwcaps.rst
+++ b/Documentation/arm64/elf_hwcaps.rst
@@ -242,44 +242,34 @@ HWCAP2_MTE3
by Documentation/arm64/memory-tagging-extension.rst.

HWCAP2_SME
-
Functionality implied by ID_AA64PFR1_EL1.SME == 0b0001, as described
by Documentation/arm64/sme.rst.

HWCAP2_SME_I16I64
-
Functionality implied by ID_AA64SMFR0_EL1.I16I64 == 0b1111.

HWCAP2_SME_F64F64
-
Functionality implied by ID_AA64SMFR0_EL1.F64F64 == 0b1.

HWCAP2_SME_I8I32
-
Functionality implied by ID_AA64SMFR0_EL1.I8I32 == 0b1111.

HWCAP2_SME_F16F32
-
Functionality implied by ID_AA64SMFR0_EL1.F16F32 == 0b1.

HWCAP2_SME_B16F32
-
Functionality implied by ID_AA64SMFR0_EL1.B16F32 == 0b1.

HWCAP2_SME_F32F32
-
Functionality implied by ID_AA64SMFR0_EL1.F32F32 == 0b1.

HWCAP2_SME_FA64
-
Functionality implied by ID_AA64SMFR0_EL1.FA64 == 0b1.

HWCAP2_WFXT
-
Functionality implied by ID_AA64ISAR2_EL1.WFXT == 0b0010.

HWCAP2_EBF16
-
Functionality implied by ID_AA64ISAR1_EL1.BF16 == 0b0010.

4. Unused AT_HWCAP bits
--
2.37.1

2022-08-18 17:21:57

by Mark Brown

[permalink] [raw]
Subject: Re: [PATCH v2] docs/arm64: elf_hwcaps: unify newlines in HWCAP lists

On Mon, Aug 15, 2022 at 03:37:58PM +0200, Martin Liška wrote:
> In git revision 94bdaa7d9a9d778d893c670d494c06d8e007c1cd I unified
> vertical spaces in a list of features.

The normal way of describing commits in a human readable fashion is to
include their title as is done in Fixes: tags.

> Since the revision, another commits added new features that have a different
> horizontal spacing.
> Fix these extra newlines.

This new format .rst is forcing does seem less than ideal for people
reading the actual file but oh well

Reviewed-by: Mark Brown <[email protected]>


Attachments:
(No filename) (589.00 B)
signature.asc (499.00 B)
Download all attachments

2022-08-18 20:42:03

by Martin Liška

[permalink] [raw]
Subject: [PATCH v3] docs/arm64: elf_hwcaps: unify newlines in HWCAP lists

Unify horizontal spacing (remove extra newlines) which
are sensitive to visual presentation by Sphinx.

Fixes: 5e64b862c482 (arm64/sme: Basic enumeration support)
Signed-off-by: Martin Liska <[email protected]>
Reviewed-by: Mark Brown <[email protected]>
---
Documentation/arm64/elf_hwcaps.rst | 10 ----------
1 file changed, 10 deletions(-)

diff --git a/Documentation/arm64/elf_hwcaps.rst b/Documentation/arm64/elf_hwcaps.rst
index 52b75a25c205..311021f2e560 100644
--- a/Documentation/arm64/elf_hwcaps.rst
+++ b/Documentation/arm64/elf_hwcaps.rst
@@ -242,44 +242,34 @@ HWCAP2_MTE3
by Documentation/arm64/memory-tagging-extension.rst.

HWCAP2_SME
-
Functionality implied by ID_AA64PFR1_EL1.SME == 0b0001, as described
by Documentation/arm64/sme.rst.

HWCAP2_SME_I16I64
-
Functionality implied by ID_AA64SMFR0_EL1.I16I64 == 0b1111.

HWCAP2_SME_F64F64
-
Functionality implied by ID_AA64SMFR0_EL1.F64F64 == 0b1.

HWCAP2_SME_I8I32
-
Functionality implied by ID_AA64SMFR0_EL1.I8I32 == 0b1111.

HWCAP2_SME_F16F32
-
Functionality implied by ID_AA64SMFR0_EL1.F16F32 == 0b1.

HWCAP2_SME_B16F32
-
Functionality implied by ID_AA64SMFR0_EL1.B16F32 == 0b1.

HWCAP2_SME_F32F32
-
Functionality implied by ID_AA64SMFR0_EL1.F32F32 == 0b1.

HWCAP2_SME_FA64
-
Functionality implied by ID_AA64SMFR0_EL1.FA64 == 0b1.

HWCAP2_WFXT
-
Functionality implied by ID_AA64ISAR2_EL1.WFXT == 0b0010.

HWCAP2_EBF16
-
Functionality implied by ID_AA64ISAR1_EL1.BF16 == 0b0010.

4. Unused AT_HWCAP bits
--
2.37.2

2022-08-23 14:36:00

by Will Deacon

[permalink] [raw]
Subject: Re: [PATCH v3] docs/arm64: elf_hwcaps: unify newlines in HWCAP lists

On Thu, 18 Aug 2022 22:31:57 +0200, Martin Liška wrote:
> Unify horizontal spacing (remove extra newlines) which
> are sensitive to visual presentation by Sphinx.
>
>

Applied to arm64 (for-next/fixes), thanks!

[1/1] docs/arm64: elf_hwcaps: unify newlines in HWCAP lists
https://git.kernel.org/arm64/c/0b52f76351bf

Cheers,
--
Will

https://fixes.arm64.dev
https://next.arm64.dev
https://will.arm64.dev