[13/13] arm: pgtable: refer to intended CONFIG_ARM_LPAE in comment

Commit Message

Lukas Bulwahn Oct. 28, 2021, 2:19 p.m. UTC

Commit 5615f69bc209 ("ARM: 9016/2: Initialize the mapping of KASan shadow
memory") adds some nested ifdef's in ./arch/arm/mm/pgd.c, and follows the
good practice to annotate the endif's with a comment to indicate the
corresponding ifdef condition.

One comment annotation refers to CONFIG_LPAE, whereas the config is
actually called CONFIG_ARM_LPAE. That imprecision in a comment is probably
tolerable for all human readers.

However, the script ./scripts/checkkconfigsymbols.py, which checks the
kernel tree for references to non-existing Kconfig symbols, identifies and
reports that the reference to CONFIG_LPAE is invalid.

The script ./scripts/checkkconfigsymbols.py has been quite useful to
identify a number of bugs with Kconfig symbols and deserves to be executed
and checked regularly.

So, repair the comment to reduce the reports from this script and simplify
to use this script, as new issues are easier to spot when the list of
reports is shorter.

Signed-off-by: Lukas Bulwahn <[e-mail]>
---
 arch/arm/mm/pgd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Arnd Bergmann Oct. 28, 2021, 2:58 p.m. UTC | #1

On Thu, Oct 28, 2021 at 4:19 PM Lukas Bulwahn <[e-mail]> wrote:
>
> Commit 5615f69bc209 ("ARM: 9016/2: Initialize the mapping of KASan shadow
> memory") adds some nested ifdef's in ./arch/arm/mm/pgd.c, and follows the
> good practice to annotate the endif's with a comment to indicate the
> corresponding ifdef condition.
>
> One comment annotation refers to CONFIG_LPAE, whereas the config is
> actually called CONFIG_ARM_LPAE. That imprecision in a comment is probably
> tolerable for all human readers.
>
> However, the script ./scripts/checkkconfigsymbols.py, which checks the
> kernel tree for references to non-existing Kconfig symbols, identifies and
> reports that the reference to CONFIG_LPAE is invalid.
>
> The script ./scripts/checkkconfigsymbols.py has been quite useful to
> identify a number of bugs with Kconfig symbols and deserves to be executed
> and checked regularly.
>
> So, repair the comment to reduce the reports from this script and simplify
> to use this script, as new issues are easier to spot when the list of
> reports is shorter.
>
> Signed-off-by: Lukas Bulwahn <[e-mail]>

Reviewed-by: Arnd Bergmann <[e-mail]>

Linus Walleij Nov. 9, 2021, 4:52 a.m. UTC | #2

On Thu, Oct 28, 2021 at 4:20 PM Lukas Bulwahn <[e-mail]> wrote:

> Commit 5615f69bc209 ("ARM: 9016/2: Initialize the mapping of KASan shadow
> memory") adds some nested ifdef's in ./arch/arm/mm/pgd.c, and follows the
> good practice to annotate the endif's with a comment to indicate the
> corresponding ifdef condition.
>
> One comment annotation refers to CONFIG_LPAE, whereas the config is
> actually called CONFIG_ARM_LPAE. That imprecision in a comment is probably
> tolerable for all human readers.
>
> However, the script ./scripts/checkkconfigsymbols.py, which checks the
> kernel tree for references to non-existing Kconfig symbols, identifies and
> reports that the reference to CONFIG_LPAE is invalid.
>
> The script ./scripts/checkkconfigsymbols.py has been quite useful to
> identify a number of bugs with Kconfig symbols and deserves to be executed
> and checked regularly.
>
> So, repair the comment to reduce the reports from this script and simplify
> to use this script, as new issues are easier to spot when the list of
> reports is shorter.
>
> Signed-off-by: Lukas Bulwahn <[e-mail]>

Reviewed-by: Linus Walleij <[e-mail]>

Please put this patch into Russell's patch tracker!

Yours,
Linus Walleij

Patch

diff --git a/arch/arm/mm/pgd.c b/arch/arm/mm/pgd.c
index f8e9bc58a84f..bf2935f21c12 100644
--- a/arch/arm/mm/pgd.c
+++ b/arch/arm/mm/pgd.c
@@ -80,7 +80,7 @@  pgd_t *pgd_alloc(struct mm_struct *mm)
 	       * sizeof(pmd_t));
 	clean_dcache_area(new_pmd, PTRS_PER_PMD * sizeof(pmd_t));
 #endif /* CONFIG_KASAN */
-#endif /* CONFIG_LPAE */
+#endif /* CONFIG_ARM_LPAE */
 
 	if (!vectors_high()) {
 		/*