Skip to contentSkip to conversation

KVM: arm64: Don't use kerneldoc comment for arm64_check_features()

PATCH Applied Oliver Upton 3 participants 4 messages Sep 13, 2023 – Sep 18, 2023

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 KVM: arm64: Don't use kerneldoc comment for arm64_check_features()

A double-asterisk opening mark to the comment (i.e. '/**') indicates a comment block is in the kerneldoc format. There's automation in place to validate that kerneldoc blocks actually adhere to the formatting rules.

The function comment for arm64_check_features() isn't kerneldoc; use a 'regular' comment to silence automation warnings.

---
 arch/arm64/kvm/sys_regs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/arm64/kvm/sys_regs.c +1 -1
index e92ec810d449..818a52e257ed 100644
@@ -1228,7 +1228,7 @@ static s64 kvm_arm64_ftr_safe_value(u32 id, const struct arm64_ftr_bits *ftrp,
 	return arm64_ftr_safe_value(&kvm_ftr, new, cur);
 }
 
-/**
+/*
  * arm64_check_features() - Check if a feature register value constitutes
  * a subset of features indicated by the idreg's KVM sanitised limit.
  *

base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d

Signature · 1 line
2.42.0.459.ge4e396fd5e-goog
#1 lore raw

Hi Oliver,

Quoted 19 lines · Oliver Upton

A double-asterisk opening mark to the comment (i.e. '/**') indicates a comment block is in the kerneldoc format. There's automation in place to validate that kerneldoc blocks actually adhere to the formatting rules.

The function comment for arm64_check_features() isn't kerneldoc; use a 'regular' comment to silence automation warnings.

---
 arch/arm64/kvm/sys_regs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/arm64/kvm/sys_regs.c +0 -0
index e92ec810d449..818a52e257ed 100644

arch/arm64/kvm/sys_regs.c static s64 kvm_arm64_ftr_safe_value(u32 id, const struct arm64_ftr_bits *ftrp, · line 1231

Quoted 5 lines
arch/arm64/kvm/sys_regs.c +1 -1
@@ -1228,7 +1228,7 @@ static s64 kvm_arm64_ftr_safe_value(u32 id, const struct arm64_ftr_bits *ftrp,
        return arm64_ftr_safe_value(&kvm_ftr, new, cur);
 }
 
-/**
+/*

Thanks for the fix.
Jing

Quoted 8 lines
arch/arm64/kvm/sys_regs.c +0 -0
  * arm64_check_features() - Check if a feature register value constitutes
  * a subset of features indicated by the idreg's KVM sanitised limit.
  *

base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d --
2.42.0.459.ge4e396fd5e-goog

reviewer Reviewed-by on v1 1/1
#2 lore raw
In reply to Oliver Upton
Quoted 4 lines · Oliver Upton

A double-asterisk opening mark to the comment (i.e. '/**') indicates a comment block is in the kerneldoc format. There's automation in place to validate that kerneldoc blocks actually adhere to the formatting rules.

Quoted 8 lines

The function comment for arm64_check_features() isn't kerneldoc; use a 'regular' comment to silence automation warnings.

---
 arch/arm64/kvm/sys_regs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
author Applied
#3 lore raw
In reply to Oliver Upton
Quoted 8 lines · Oliver Upton

A double-asterisk opening mark to the comment (i.e. '/**') indicates a comment block is in the kerneldoc format. There's automation in place to validate that kerneldoc blocks actually adhere to the formatting rules.

The function comment for arm64_check_features() isn't kerneldoc; use a 'regular' comment to silence automation warnings.

[...]

Applied to kvmarm/next, thanks!

[1/1] KVM: arm64: Don't use kerneldoc comment for arm64_check_features()

      https://git.kernel.org/kvmarm/kvmarm/c/7b424ffcd458

--
Best,
Oliver