From: Stefano Stabellini <sstabellini@kernel.org>
To: xen-devel@lists.xenproject.org
Cc: sstabellini@kernel.org, julien@xen.org, wl@xen.org,
andrew.cooper3@citrix.com, ian.jackson@eu.citrix.com,
george.dunlap@citrix.com, jbeulich@suse.com,
Stefano Stabellini <stefano.stabellini@xilinx.com>
Subject: [PATCH 07/14] kernel-doc: public/hypfs.h
Date: Thu, 6 Aug 2020 16:49:26 -0700 [thread overview]
Message-ID: <20200806234933.16448-7-sstabellini@kernel.org> (raw)
In-Reply-To: <alpine.DEB.2.21.2008061605410.16004@sstabellini-ThinkPad-T480s>
From: Stefano Stabellini <stefano.stabellini@xilinx.com>
Convert in-code comments to kernel-doc format wherever possible.
Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
---
xen/include/public/hypfs.h | 72 ++++++++++++++++++++++++--------------
1 file changed, 45 insertions(+), 27 deletions(-)
diff --git a/xen/include/public/hypfs.h b/xen/include/public/hypfs.h
index 63a5df1629..ef33aee4ce 100644
--- a/xen/include/public/hypfs.h
+++ b/xen/include/public/hypfs.h
@@ -32,12 +32,21 @@
* Definitions for the __HYPERVISOR_hypfs_op hypercall.
*/
-/* Highest version number of the hypfs interface currently defined. */
+/**
+ * DOC: XEN_HYPFS_VERSION
+ * Highest version number of the hypfs interface currently defined.
+ */
#define XEN_HYPFS_VERSION 1
-/* Maximum length of a path in the filesystem. */
+/**
+ * DOC: XEN_HYPFS_MAX_PATHLEN
+ * Maximum length of a path in the filesystem.
+ */
#define XEN_HYPFS_MAX_PATHLEN 1024
+/**
+ * struct xen_hypfs_direntry
+ */
struct xen_hypfs_direntry {
uint8_t type;
#define XEN_HYPFS_TYPE_DIR 0
@@ -49,16 +58,22 @@ struct xen_hypfs_direntry {
uint8_t encoding;
#define XEN_HYPFS_ENC_PLAIN 0
#define XEN_HYPFS_ENC_GZIP 1
- uint16_t pad; /* Returned as 0. */
- uint32_t content_len; /* Current length of data. */
- uint32_t max_write_len; /* Max. length for writes (0 if read-only). */
+ /** @pad: Returned as 0. */
+ uint16_t pad;
+ /** @content_len: Current length of data. */
+ uint32_t content_len;
+ /** @max_write_len: Max. length for writes (0 if read-only). */
+ uint32_t max_write_len;
};
+/**
+ * struct xen_hypfs_dirlistentry
+ */
struct xen_hypfs_dirlistentry {
struct xen_hypfs_direntry e;
- /* Offset in bytes to next entry (0 == this is the last entry). */
+ /** @off_next: Offset in bytes to next entry (0 == this is the last entry). */
uint16_t off_next;
- /* Zero terminated entry name, possibly with some padding for alignment. */
+ /** @name: Zero terminated entry name, possibly with some padding for alignment. */
char name[XEN_FLEX_ARRAY_DIM];
};
@@ -66,21 +81,22 @@ struct xen_hypfs_dirlistentry {
* Hypercall operations.
*/
-/*
- * XEN_HYPFS_OP_get_version
+/**
+ * DOC: XEN_HYPFS_OP_get_version
*
* Read highest interface version supported by the hypervisor.
*
* arg1 - arg4: all 0/NULL
*
* Possible return values:
- * >0: highest supported interface version
- * <0: negative Xen errno value
+ *
+ * - >0: highest supported interface version
+ * - <0: negative Xen errno value
*/
#define XEN_HYPFS_OP_get_version 0
-/*
- * XEN_HYPFS_OP_read
+/**
+ * DOC: XEN_HYPFS_OP_read
*
* Read a filesystem entry.
*
@@ -95,19 +111,20 @@ struct xen_hypfs_dirlistentry {
* The contents of a directory are multiple struct xen_hypfs_dirlistentry
* items.
*
- * arg1: XEN_GUEST_HANDLE(path name)
- * arg2: length of path name (including trailing zero byte)
- * arg3: XEN_GUEST_HANDLE(data buffer written by hypervisor)
- * arg4: data buffer size
+ * - arg1: XEN_GUEST_HANDLE(path name)
+ * - arg2: length of path name (including trailing zero byte)
+ * - arg3: XEN_GUEST_HANDLE(data buffer written by hypervisor)
+ * - arg4: data buffer size
*
* Possible return values:
- * 0: success
- * <0 : negative Xen errno value
+ *
+ * - 0: success
+ * - <0 : negative Xen errno value
*/
#define XEN_HYPFS_OP_read 1
-/*
- * XEN_HYPFS_OP_write_contents
+/**
+ * DOC: XEN_HYPFS_OP_write_contents
*
* Write contents of a filesystem entry.
*
@@ -115,14 +132,15 @@ struct xen_hypfs_dirlistentry {
* The data type and encoding can't be changed. The size can be changed only
* for blobs and strings.
*
- * arg1: XEN_GUEST_HANDLE(path name)
- * arg2: length of path name (including trailing zero byte)
- * arg3: XEN_GUEST_HANDLE(content buffer read by hypervisor)
- * arg4: content buffer size
+ * - arg1: XEN_GUEST_HANDLE(path name)
+ * - arg2: length of path name (including trailing zero byte)
+ * - arg3: XEN_GUEST_HANDLE(content buffer read by hypervisor)
+ * - arg4: content buffer size
*
* Possible return values:
- * 0: success
- * <0 : negative Xen errno value
+ *
+ * - 0: success
+ * - <0: negative Xen errno value
*/
#define XEN_HYPFS_OP_write_contents 2
--
2.17.1
next prev parent reply other threads:[~2020-08-06 23:49 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-06 23:49 [PATCH 00/14] kernel-doc: public/arch-arm.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 01/14] " Stefano Stabellini
2020-08-18 12:42 ` Ian Jackson
2020-08-20 19:05 ` Stefano Stabellini
2020-08-06 23:49 ` [PATCH 02/14] kernel-doc: public/hvm/hvm_op.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 03/14] kernel-doc: public/device_tree_defs.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 04/14] kernel-doc: public/event_channel.h Stefano Stabellini
2020-08-07 13:01 ` Jan Beulich
2020-08-07 21:51 ` Stefano Stabellini
2020-08-06 23:49 ` [PATCH 05/14] kernel-doc: public/features.h Stefano Stabellini
2020-08-07 12:54 ` Jan Beulich
2020-08-07 21:52 ` Stefano Stabellini
2020-08-17 15:26 ` Jan Beulich
2020-08-17 22:56 ` Stefano Stabellini
2020-08-06 23:49 ` [PATCH 06/14] kernel-doc: public/grant_table.h Stefano Stabellini
2020-08-07 12:59 ` Jan Beulich
2020-08-07 21:51 ` Stefano Stabellini
2020-08-06 23:49 ` Stefano Stabellini [this message]
2020-08-06 23:49 ` [PATCH 08/14] kernel-doc: public/memory.h Stefano Stabellini
2020-08-07 13:07 ` Jan Beulich
2020-08-07 21:51 ` Stefano Stabellini
2020-08-17 15:32 ` Jan Beulich
2020-08-17 22:56 ` Stefano Stabellini
2020-08-18 8:05 ` Jan Beulich
2020-08-20 23:20 ` Stefano Stabellini
2020-08-06 23:49 ` [PATCH 09/14] kernel-doc: public/sched.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 10/14] kernel-doc: public/vcpu.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 11/14] kernel-doc: public/version.h Stefano Stabellini
2020-08-07 13:12 ` Jan Beulich
2020-08-07 21:51 ` Stefano Stabellini
2020-08-06 23:49 ` [PATCH 12/14] kernel-doc: public/xen.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 13/14] kernel-doc: public/elfnote.h Stefano Stabellini
2020-08-06 23:49 ` [PATCH 14/14] kernel-doc: public/hvm/params.h Stefano Stabellini
2020-08-07 8:48 ` [PATCH 00/14] kernel-doc: public/arch-arm.h Jan Beulich
2020-08-07 21:51 ` Stefano Stabellini
2020-08-07 16:56 ` Stefano Stabellini
2020-08-18 12:52 ` Ian Jackson
2020-08-20 19:02 ` Stefano Stabellini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200806234933.16448-7-sstabellini@kernel.org \
--to=sstabellini@kernel.org \
--cc=andrew.cooper3@citrix.com \
--cc=george.dunlap@citrix.com \
--cc=ian.jackson@eu.citrix.com \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=stefano.stabellini@xilinx.com \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).