| commit | 4cf41794411f91453e19da88ecb7e806a831abf8 | |
| author | Paolo Bonzini <pbonzini@redhat.com> | |
| Tue, 29 Oct 2019 16:22:44 +0000 (29 17:22 +0100) | ||
| committer | Paolo Bonzini <pbonzini@redhat.com> | |
| Tue, 17 Dec 2019 18:36:57 +0000 (17 19:36 +0100) | ||
| tree | 72c8cbeda68aea406c099bf5a3d98c62a3a58b8c | treesnapshot (tar.gz zip) |
| parent | e2c546358f0eaccc001f457a9eec0ecbe9d3bed7 | commitdiff |
docs: tweak kernel-doc for QEMU coding standards
Surprisingly, QEMU does have a pretty consistent doc comment style and
it is not very different from the Linux kernel's. Of the documentation
"sigils", only "#" separates the QEMU doc comment style from Linux's,
and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in
accel/tcg/translate-all.c), so it's clear that the two standards are
different in this respect. In addition, our structs are typedefed and
recognized by CamelCase names.
Adjust kernel-doc's parser for these two aspects of the QEMU coding
standards. The patch has been valid, with hardly any change, for over
two years, so it should not be an issue to keep kernel-doc in sync with
the Linux copy.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Surprisingly, QEMU does have a pretty consistent doc comment style and
it is not very different from the Linux kernel's. Of the documentation
"sigils", only "#" separates the QEMU doc comment style from Linux's,
and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in
accel/tcg/translate-all.c), so it's clear that the two standards are
different in this respect. In addition, our structs are typedefed and
recognized by CamelCase names.
Adjust kernel-doc's parser for these two aspects of the QEMU coding
standards. The patch has been valid, with hardly any change, for over
two years, so it should not be an issue to keep kernel-doc in sync with
the Linux copy.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
| scripts/kernel-doc | diffblobblamehistory |