From: Gaetan Rivet <gaetan.rivet@6wind.com>
To: dev@dpdk.org
Cc: Gaetan Rivet <gaetan.rivet@6wind.com>
Subject: [dpdk-dev] [PATCH v1 7/8] option: improve library documentation
Date: Thu, 20 Dec 2018 18:06:46 +0100 [thread overview]
Message-ID: <7f6edf0902fe095391db3f090533a66b9f9e9507.1545325395.git.gaetan.rivet@6wind.com> (raw)
In-Reply-To: <cover.1545325395.git.gaetan.rivet@6wind.com>
Use doxygen to describe the main structure and describe a little more
why it exists.
Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
---
lib/librte_eal/common/include/rte_option.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/lib/librte_eal/common/include/rte_option.h b/lib/librte_eal/common/include/rte_option.h
index eea95e477..20be47d91 100644
--- a/lib/librte_eal/common/include/rte_option.h
+++ b/lib/librte_eal/common/include/rte_option.h
@@ -29,8 +29,12 @@ extern "C" {
typedef int (*rte_option_cb)(void);
-/*
- * Structure describing the EAL command line option being registered.
+/**
+ * Structure describing an EAL command line option dynamically registered.
+ *
+ * Common EAL options are mostly statically defined.
+ * Some libraries need additional options to be dynamically added.
+ * This structure describes such options.
*/
struct rte_option {
TAILQ_ENTRY(rte_option) next; /**< Next entry in the list. */
--
2.19.1
next prev parent reply other threads:[~2018-12-20 17:07 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-20 17:06 [dpdk-dev] [PATCH v1 0/8] Clean up rte_option Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 1/8] option: use bare option string as name Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 2/8] option: do not use static iterator Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 3/8] option: add usage string Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 4/8] option: rename name field Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 5/8] option: check against common option on register Gaetan Rivet
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 6/8] option: fix log level of error in register Gaetan Rivet
2018-12-20 17:06 ` Gaetan Rivet [this message]
2018-12-20 17:06 ` [dpdk-dev] [PATCH v1 8/8] option: return an error when register fail Gaetan Rivet
2019-01-15 1:23 ` [dpdk-dev] [PATCH v1 0/8] Clean up rte_option 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=7f6edf0902fe095391db3f090533a66b9f9e9507.1545325395.git.gaetan.rivet@6wind.com \
--to=gaetan.rivet@6wind.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).