From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH 4/5] eal: mark internal interrupts file as such to doxygen
Date: Thu, 19 Oct 2017 17:36:28 +0100 [thread overview]
Message-ID: <20171019163629.28618-5-bruce.richardson@intel.com> (raw)
In-Reply-To: <20171019163629.28618-1-bruce.richardson@intel.com>
Put a file-level comment on rte_eal_interrupts.h to mark it as an
internal only header.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
lib/librte_eal/common/include/rte_eal_interrupts.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/lib/librte_eal/common/include/rte_eal_interrupts.h b/lib/librte_eal/common/include/rte_eal_interrupts.h
index 64f8e1eb3..5628f62c1 100644
--- a/lib/librte_eal/common/include/rte_eal_interrupts.h
+++ b/lib/librte_eal/common/include/rte_eal_interrupts.h
@@ -35,6 +35,14 @@
#error "don't include this file directly, please include generic <rte_interrupts.h>"
#endif
+/**
+ * @file rte_eal_interrupts.h
+ * @internal
+ *
+ * Contains function prototypes exposed by the EAL for interrupt handling by
+ * drivers and other DPDK internal consumers.
+ */
+
#ifndef _RTE_EAL_INTERRUPTS_H_
#define _RTE_EAL_INTERRUPTS_H_
--
2.13.6
next prev parent reply other threads:[~2017-10-19 16:44 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-19 16:36 [dpdk-dev] [PATCH 0/5] Merge Linux and BSD EAL map files Bruce Richardson
2017-10-19 16:36 ` [dpdk-dev] [PATCH 1/5] eal/bsdapp: align interrupt include file with Linux version Bruce Richardson
2017-10-19 16:36 ` [dpdk-dev] [PATCH 2/5] eal/bsdapp: fix missing interrupt stub functions Bruce Richardson
2017-10-20 9:12 ` Bruce Richardson
2017-10-19 16:36 ` [dpdk-dev] [PATCH 3/5] eal: merge bsdapp and linuxapp interrupt headers Bruce Richardson
2017-10-19 16:36 ` Bruce Richardson [this message]
2017-10-19 16:36 ` [dpdk-dev] [PATCH 5/5] eal: use a single version map file Bruce Richardson
2017-10-23 23:21 ` Thomas Monjalon
2017-10-24 9:48 ` Bruce Richardson
2017-10-19 16:45 ` [dpdk-dev] [PATCH 0/5] Merge Linux and BSD EAL map files Bruce Richardson
2017-10-23 23:23 ` Thomas Monjalon
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=20171019163629.28618-5-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.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).