DPDK usage discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Asaf Penso <asafp@nvidia.com>
Cc: "users@dpdk.org" <users@dpdk.org>,
	dev@dpdk.org, david.marchand@redhat.com,
	bruce.richardson@intel.com, ferruh.yigit@intel.com,
	ajit.khaparde@broadcom.com, jerinj@marvell.com,
	gakhil@marvell.com, maxime.coquelin@redhat.com
Subject: Re: [dpdk-users] [DISCUSSION] code snippet documentation
Date: Thu, 22 Jul 2021 22:29:56 +0200
Message-ID: <2236865.drsZmlonQt@thomas> (raw)
In-Reply-To: <DM8PR12MB5494C65A49F85CBD33BE8E34CD129@DM8PR12MB5494.namprd12.prod.outlook.com>

15/07/2021 09:01, Asaf Penso:
> Hello DPDK community,
> I would like to bring up a discussion about a way to have code snippets as an example for proper usage.
> The DPDK tree is filled with great pieces of code that are well documented and maintained in high quality.
> I feel we are a bit behind when we talk about usage examples.
> One way, whenever we implement a new feature, is to extend one of the test-* under the "app" folder.
> This, however, provides means to test but doesn't provide a good usage example.
> Another way is to check the content of the "example" folder and whenever we have a BIG new feature it seems like a good place.
> This, however, doesn't provide a good option when we talk about small features.
> If, for example, we extend rte_flow with an extra action then providing a full-blown example application is somewhat an entry barrier.
> A third option could be to document it in one of the .rst files we have.
> Obviously, this requires high maintenance and no option to assure it still compiles.
> I'd like to propose another approach that will address the main two issues: remove the entry barrier and assure compilation.
> In this approach, inside the "examples" folder we'll create another folder for "snippets".
> Inside "snippets" we'll have several files per category, for example, rte_flow_snippets.c
> Each .c file will include a main function that calls the different use cases we want to give as an example.
> The purpose is not to generate traffic nor read rx/tx packets from the DPDK ports. 
> The purpose is to have a good example that compiles properly.
> Taking the rte_flow_snippets.c as an example its main function would look like this:
> int
> main(int argc, char **argv)
> {
>       rte_flow_snippet_match_5tuple_and_drop();
>       rte_flow_snippet_match_geneve_ope_and_rss();
>       ...
>       Return 0;
> }

I think we need to have a policy or justification about which snippet
is worth to have.
My thought is to avoid creating snippets which have no other value
than showing a function call.
I think there is a value if the context is not simple.

Please could you provide a more complex example?

  reply	other threads:[~2021-07-22 20:29 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-15  7:01 Asaf Penso
2021-07-22 20:29 ` Thomas Monjalon [this message]
2021-07-23  0:02   ` Ajit Khaparde
2021-07-23 12:03     ` Ferruh Yigit
2021-07-25  4:53       ` Asaf Penso
2021-11-21 15:11         ` Asaf Penso

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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2236865.drsZmlonQt@thomas \
    --to=thomas@monjalon.net \
    --cc=ajit.khaparde@broadcom.com \
    --cc=asafp@nvidia.com \
    --cc=bruce.richardson@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=gakhil@marvell.com \
    --cc=jerinj@marvell.com \
    --cc=maxime.coquelin@redhat.com \
    --cc=users@dpdk.org \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK usage discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/users/0 users/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 users users/ http://inbox.dpdk.org/users \
	public-inbox-index users

Example config snippet for mirrors.
Newsgroup available over NNTP:

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git