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 03/14] kernel-doc: public/device_tree_defs.h
Date: Thu, 6 Aug 2020 16:49:22 -0700 [thread overview]
Message-ID: <20200806234933.16448-3-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/device_tree_defs.h | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/xen/include/public/device_tree_defs.h b/xen/include/public/device_tree_defs.h
index 209d43de3f..be35598b53 100644
--- a/xen/include/public/device_tree_defs.h
+++ b/xen/include/public/device_tree_defs.h
@@ -2,7 +2,9 @@
#define __XEN_DEVICE_TREE_DEFS_H__
#if defined(__XEN__) || defined(__XEN_TOOLS__)
-/*
+/**
+ * DOC: GUEST_PHANDLE_GIC
+ *
* The device tree compiler (DTC) is allocating the phandle from 1 to
* onwards. Reserve a high value for the GIC phandle.
*/
@@ -12,17 +14,17 @@
#define GUEST_ROOT_SIZE_CELLS 2
/**
- * IRQ line type.
+ * DOC: IRQ line type.
*
- * DT_IRQ_TYPE_NONE - default, unspecified type
- * DT_IRQ_TYPE_EDGE_RISING - rising edge triggered
- * DT_IRQ_TYPE_EDGE_FALLING - falling edge triggered
- * DT_IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
- * DT_IRQ_TYPE_LEVEL_HIGH - high level triggered
- * DT_IRQ_TYPE_LEVEL_LOW - low level triggered
- * DT_IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
- * DT_IRQ_TYPE_SENSE_MASK - Mask for all the above bits
- * DT_IRQ_TYPE_INVALID - Use to initialize the type
+ * - DT_IRQ_TYPE_NONE - default, unspecified type
+ * - DT_IRQ_TYPE_EDGE_RISING - rising edge triggered
+ * - DT_IRQ_TYPE_EDGE_FALLING - falling edge triggered
+ * - DT_IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
+ * - DT_IRQ_TYPE_LEVEL_HIGH - high level triggered
+ * - DT_IRQ_TYPE_LEVEL_LOW - low level triggered
+ * - DT_IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
+ * - DT_IRQ_TYPE_SENSE_MASK - Mask for all the above bits
+ * - DT_IRQ_TYPE_INVALID - Use to initialize the type
*/
#define DT_IRQ_TYPE_NONE 0x00000000
#define DT_IRQ_TYPE_EDGE_RISING 0x00000001
--
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 ` Stefano Stabellini [this message]
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 ` [PATCH 07/14] kernel-doc: public/hypfs.h Stefano Stabellini
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-3-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.