Skip to contentSkip to conversation

9pfs: drop Doxygen format from qemu_dirent_dup() API comment

PATCH In review Christian Schoenebeck 3 participants 6 messages Mar 2, 2022 – Mar 3, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 9pfs: drop Doxygen format from qemu_dirent_dup() API comment

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Based-on: <[email protected]>

---
 hw/9pfs/9p-util.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
hw/9pfs/9p-util.h +2 -2
index 8b92614e6c..22835c5f61 100644
@@ -116,8 +116,8 @@ static inline off_t qemu_dirent_off(struct dirent *dent)
  * Duplicate directory entry @dent.
  *
  * It is highly recommended to use this function instead of open coding
- * duplication of @c dirent objects, because the actual @c struct @c dirent
- * size may be bigger or shorter than @c sizeof(struct dirent) and correct
+ * duplication of dirent objects, because the actual struct dirent
+ * size may be bigger or shorter than sizeof(struct dirent) and correct
  * handling is platform specific (see gitlab issue #841).
  *
  * @dent - original directory entry to be duplicated
Signature · 1 line
2.30.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 17 lines · Christian Schoenebeck

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Based-on: <[email protected]>

---
 hw/9pfs/9p-util.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
hw/9pfs/9p-util.h +0 -0
index 8b92614e6c..22835c5f61 100644
@@ -116,8 +116,8 @@ static inline off_t qemu_dirent_off(struct dirent *dent)
  * Duplicate directory entry @dent.

hw/9pfs/9p-util.h static inline off_t qemu_dirent_off(struct dirent *dent)

Quoted 10 lines
hw/9pfs/9p-util.h +2 -3
  *
  * It is highly recommended to use this function instead of open coding
- * duplication of @c dirent objects, because the actual @c struct @c dirent
- * size may be bigger or shorter than @c sizeof(struct dirent) and correct
+ * duplication of dirent objects, because the actual struct dirent
+ * size may be bigger or shorter than sizeof(struct dirent) and correct
  * handling is platform specific (see gitlab issue #841).
  *
  * @dent - original directory entry to be duplicated
--

thanks
-- PMM

Reviewed-by on v1 1/1
#2 lore raw
In reply to Christian Schoenebeck
Quoted 7 lines · On Wed, 2 Mar 2022 19:30:39 +0100 Christian Schoenebeck…

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Based-on: <[email protected]>

---

Sorry for not catching these during previous reviews :-\

FWIW it seems some more de-doxygenation is needed :

fsdev/p9array.h: * Consider the following user struct @c Foo which shall be used as scalar fsdev/p9array.h: * @code
fsdev/p9array.h: * and assume it has the following function to free memory allocated by @c Foo fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
hw/9pfs/9p.h: * Lenght of the affix, that is how many (of the lowest) bits of @c value
extra nit ^^
hw/9pfs/codir.c: * @note You must @b ALWAYS call @c v9fs_free_dirents(entries) after calling

Detected with basic git grepping. Probably not exhaustive.

Quoted 18 lines
 hw/9pfs/9p-util.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
hw/9pfs/9p-util.h +2 -2
index 8b92614e6c..22835c5f61 100644
@@ -116,8 +116,8 @@ static inline off_t qemu_dirent_off(struct dirent *dent)
  * Duplicate directory entry @dent.
  *
  * It is highly recommended to use this function instead of open coding
- * duplication of @c dirent objects, because the actual @c struct @c dirent
- * size may be bigger or shorter than @c sizeof(struct dirent) and correct
+ * duplication of dirent objects, because the actual struct dirent
+ * size may be bigger or shorter than sizeof(struct dirent) and correct
  * handling is platform specific (see gitlab issue #841).
  *
  * @dent - original directory entry to be duplicated
#3 lore raw
Quoted 19 lines · On Donnerstag, 3. März 2022 10:53:32 CET Greg Kurz wrote:

On Wed, 2 Mar 2022 19:30:39 +0100

Quoted 9 lines · Christian Schoenebeck

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Link:
https://lore.kernel.org/qemu-devel/CAFEAcA89+ENOM6x19OEF53Kd2DWkhN5SN21Va
[email protected]/ Based-on:
<[email protected]>

---

Sorry for not catching these during previous reviews :-\

FWIW it seems some more de-doxygenation is needed :

Quoted 11 lines

fsdev/p9array.h: * Consider the following user struct @c Foo which shall be used as scalar fsdev/p9array.h: * @code
fsdev/p9array.h: * and assume it has the following function to free memory allocated by @c Foo fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
hw/9pfs/9p.h: * Lenght of the affix, that is how many (of the lowest)
bits of @c value extra nit ^^
hw/9pfs/codir.c: * @note You must @b ALWAYS call @c v9fs_free_dirents(entries) after calling

OK, I send more patches to wipe these as well today.

Greg, if something is tagged as junk email at your end, please remove it from the subject line, otherwise I will not receive your reply. It was pure luck that I noticed your message on the archives this time.

Best regards,
Christian Schoenebeck

#4 lore raw
Quoted 32 lines · On Thu, 03 Mar 2022 11:55:36 +0100 Christian Schoenebeck…
Quoted 19 lines · On Donnerstag, 3. März 2022 10:53:32 CET Greg Kurz wrote:

On Wed, 2 Mar 2022 19:30:39 +0100

Quoted 9 lines · Christian Schoenebeck

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Link:
https://lore.kernel.org/qemu-devel/CAFEAcA89+ENOM6x19OEF53Kd2DWkhN5SN21Va
[email protected]/ Based-on:
<[email protected]>

---

Sorry for not catching these during previous reviews :-\

FWIW it seems some more de-doxygenation is needed :

Quoted 11 lines

fsdev/p9array.h: * Consider the following user struct @c Foo which shall be used as scalar fsdev/p9array.h: * @code
fsdev/p9array.h: * and assume it has the following function to free memory allocated by @c Foo fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
hw/9pfs/9p.h: * Lenght of the affix, that is how many (of the lowest)
bits of @c value extra nit ^^
hw/9pfs/codir.c: * @note You must @b ALWAYS call @c v9fs_free_dirents(entries) after calling

Quoted 6 lines

OK, I send more patches to wipe these as well today.

Greg, if something is tagged as junk email at your end, please remove it from the subject line, otherwise I will not receive your reply. It was pure luck that I noticed your message on the archives this time.

Sure... I usually do but I forgot this time. Sorry for that.

Since you seem to be the only affected person which I receive mail from, I'll try to automate this on my side.

Quoted 4 lines

Best regards,
Christian Schoenebeck

#5 lore raw
In reply to Christian Schoenebeck
Quoted 11 lines · On Mittwoch, 2. März 2022 19:30:39 CET Christian Schoenebeck wrote:

API doc comments in QEMU are supposed to be in kerneldoc format, so drop occurrences of "@c" which is Doxygen format for fixed-width text.

Link:
https://lore.kernel.org/qemu-devel/CAFEAcA89+ENOM6x19OEF53Kd2DWkhN5SN21Va0D
[email protected]/ Based-on:
<[email protected]>

---
 hw/9pfs/9p-util.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Queued on 9p.next:
https://github.com/cschoenebeck/qemu/commits/9p.next

Thanks!

Best regards,
Christian Schoenebeck