From: Jesper Dangaard Brouer via iovisor-dev <iovisor-dev-9jONkmmOlFHEE9lA1F8Ukti2O/JbrIOy@public.gmane.org>
To: "netdev-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
<netdev-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
"iovisor-dev-9jONkmmOlFHEE9lA1F8Ukti2O/JbrIOy@public.gmane.org"
<iovisor-dev-9jONkmmOlFHEE9lA1F8Ukti2O/JbrIOy@public.gmane.org>
Cc: Jonathan Corbet <corbet-T1hC0tSOHrs@public.gmane.org>,
Nathan Willis <nate-T1hC0tSOHrs@public.gmane.org>,
Alexei Starovoitov <ast-b10kYP2dOMg@public.gmane.org>,
Tom Herbert <tom-BjP2VixgY4xUbtYUoyoikg@public.gmane.org>,
linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
Saeed Mahameed <saeedm-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org>
Subject: XDP (eXpress Data Path) documentation
Date: Tue, 20 Sep 2016 11:08:44 +0200 [thread overview]
Message-ID: <20160920110844.661965be@redhat.com> (raw)
Hi all,
As promised, I've started documenting the XDP eXpress Data Path):
[1] https://prototype-kernel.readthedocs.io/en/latest/networking/XDP/index.html
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/master/kernel/Documentation
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/master
next reply other threads:[~2016-09-20 9:08 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-20 9:08 Jesper Dangaard Brouer via iovisor-dev [this message]
2016-09-22 0:03 ` XDP (eXpress Data Path) documentation Tom Herbert
[not found] ` <CALx6S37W2qfceOUDnPvFM5PuGp4G3cWjgrQP5_W9Veosic61pw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2016-09-22 10:01 ` Jesper Dangaard Brouer via iovisor-dev
[not found] ` <20160920110844.661965be-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-09-21 2:47 ` Alexei Starovoitov via iovisor-dev
[not found] ` <20160921024705.GA11128-+o4/htvd0TDFYCXBM6kdu7fOX0fSgVTm@public.gmane.org>
2016-09-21 8:52 ` Jesper Dangaard Brouer via iovisor-dev
2016-09-22 18:16 ` Jesper Dangaard Brouer via iovisor-dev
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=20160920110844.661965be@redhat.com \
--to=iovisor-dev-9jonkmmolfhee9la1f8ukti2o/jbrioy@public.gmane.org \
--cc=ast-b10kYP2dOMg@public.gmane.org \
--cc=brouer-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org \
--cc=corbet-T1hC0tSOHrs@public.gmane.org \
--cc=linux-doc-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=nate-T1hC0tSOHrs@public.gmane.org \
--cc=netdev-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=saeedm-VPRAkNaXOzVWk0Htik3J/w@public.gmane.org \
--cc=tom-BjP2VixgY4xUbtYUoyoikg@public.gmane.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.