DPDK usage discussions
 help / color / mirror / Atom feed
* [dpdk-users] [DISCUSSION] code snippet documentation
@ 2021-07-15  7:01 Asaf Penso
  2021-07-22 20:29 ` Thomas Monjalon
  0 siblings, 1 reply; 6+ messages in thread
From: Asaf Penso @ 2021-07-15  7:01 UTC (permalink / raw)
  To: users

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:

main(int argc, char **argv)
      Return 0;

Asaf Penso

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-11-23 15:06 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-15  7:01 [dpdk-users] [DISCUSSION] code snippet documentation Asaf Penso
2021-07-22 20:29 ` Thomas Monjalon
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

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