|
|
Log in / Subscribe / Register

XDP (eXpress Data Path) documentation

From:  Jesper Dangaard Brouer <brouer-AT-redhat.com>
To:  "netdev-AT-vger.kernel.org" <netdev-AT-vger.kernel.org>, "iovisor-dev-AT-lists.iovisor.org" <iovisor-dev-AT-lists.iovisor.org>
Subject:  XDP (eXpress Data Path) documentation
Date:  Tue, 20 Sep 2016 11:08:44 +0200
Message-ID:  <20160920110844.661965be@redhat.com>
Cc:  brouer-AT-redhat.com, Tom Herbert <tom-AT-herbertland.com>, Tariq Toukan <tariqt-AT-mellanox.com>, Rana Shahout <rana.shahot-AT-gmail.com>, Saeed Mahameed <saeedm-AT-mellanox.com>, Brenden Blanco <bblanco-AT-plumgrid.com>, Alexei Starovoitov <ast-AT-fb.com>, Jonathan Corbet <corbet-AT-lwn.net>, Nathan Willis <nate-AT-lwn.net>, linux-doc-AT-vger.kernel.org

Hi all,

As promised, I've started documenting the XDP eXpress Data Path):

 [1] https://prototype-kernel.readthedocs.io/en/latest/network...

IMHO the documentation have reached a stage where it is useful for the
XDP project, BUT I request collaboration on improving the documentation
from all. (Native English speakers are encouraged to send grammar fixes ;-))

You wouldn't believe it: But this pretty looking documentation actually
follows the new Kernel documentation format.  It is actually just
".rst" text files stored in my github repository under kernel/Documentation [2]

 [2] https://github.com/netoptimizer/prototype-kernel/tree/mas...

Thus, just git clone my repository and started editing and send me
patches (or github pull requests). Like:

 $ git clone https://github.com/netoptimizer/prototype-kernel
 $ cd prototype-kernel/kernel/Documentation/
 $ make html
 $ firefox _build/html/index.html &

This new documentation format combines the best of two worlds, pretty
online browser documentation with almost plain text files, and changes
being tracked via git commits [3] (and auto git hooks to generate the
readthedocs.org page). You got to love it! :-)

-- 
Best regards,
  Jesper Dangaard Brouer
  MSc.CS, Principal Kernel Engineer at Red Hat
  Author of http://www.iptv-analyzer.org
  LinkedIn: http://www.linkedin.com/in/brouer

[3] https://github.com/netoptimizer/prototype-kernel/commits/...



Copyright © 2016, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds