| Message ID | 20230913165645.2319017-1-oliver.upton@linux.dev (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | KVM: arm64: Don't use kerneldoc comment for arm64_check_features() | expand |
Hi Oliver, On Wed, Sep 13, 2023 at 9:56 AM Oliver Upton <oliver.upton@linux.dev> wrote: > > 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. > > Link: https://lore.kernel.org/all/202309112251.e25LqfcK-lkp@intel.com/ > Signed-off-by: Oliver Upton <oliver.upton@linux.dev> > --- > arch/arm64/kvm/sys_regs.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/arch/arm64/kvm/sys_regs.c b/arch/arm64/kvm/sys_regs.c > index e92ec810d449..818a52e257ed 100644 > --- a/arch/arm64/kvm/sys_regs.c > +++ b/arch/arm64/kvm/sys_regs.c > @@ -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 > * 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 >
On 2023/9/14 0:56, Oliver Upton wrote: > 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. > > Link: https://lore.kernel.org/all/202309112251.e25LqfcK-lkp@intel.com/ > Signed-off-by: Oliver Upton <oliver.upton@linux.dev> > --- > arch/arm64/kvm/sys_regs.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Reviewed-by: Zenghui Yu <yuzenghui@huawei.com>
On Wed, 13 Sep 2023 16:56:44 +0000, Oliver Upton wrote: > 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
diff --git a/arch/arm64/kvm/sys_regs.c b/arch/arm64/kvm/sys_regs.c index e92ec810d449..818a52e257ed 100644 --- a/arch/arm64/kvm/sys_regs.c +++ b/arch/arm64/kvm/sys_regs.c @@ -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. *
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. Link: https://lore.kernel.org/all/202309112251.e25LqfcK-lkp@intel.com/ Signed-off-by: Oliver Upton <oliver.upton@linux.dev> --- arch/arm64/kvm/sys_regs.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) base-commit: 0bb80ecc33a8fb5a682236443c1e740d5c917d1d