summaryrefslogtreecommitdiff
path: root/dev.html
diff options
context:
space:
mode:
Diffstat (limited to 'dev.html')
-rw-r--r--dev.html154
1 files changed, 0 insertions, 154 deletions
diff --git a/dev.html b/dev.html
deleted file mode 100644
index 12bcb17..0000000
--- a/dev.html
+++ /dev/null
@@ -1,154 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8" />
- <meta name=viewport content="width=device-width, initial-scale=1" />
- <title>DPDK dev</title>
- <link rel="stylesheet" href="/reset.css" />
- <link rel="stylesheet" href="/layout.css" />
- <link rel="stylesheet" href="/content.css" />
- <script type="text/javascript">
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-39229303-1']);
- _gaq.push(['_setDomainName', 'dpdk.org']);
- _gaq.push(['_setAllowLinker', true]);
- _gaq.push(['_trackPageview']);
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = '//www.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
- </script>
-</head>
-<body>
-<header>
- <h1><a href="//dpdk.org/"><img src="/logos/dpdk.png"
- alt="DPDK: Data Plane Development Kit"></a></h1>
- <nav>
- <ul>
- <li><a href="/">Home</a>
- <li><a href="/download">Download</a>
- <li><a href="/doc">Documentation</a>
- <li><a href="/dev" id="current">Development</a>
- <li><a href="/ml">Mailing Lists</a>
- <li><a href="/events">Events</a>
- <li><a href="/news">News</a>
- <li><a href="/about">About</a>
- </ul>
- </nav>
-</header>
-<section>
- <h2>Development</h2>
- <p>Anyone is welcome to contribute.
- <p>The collaboration is based on <a href="/browse/">git</a>
- and <a href="/ml/archives/dev">emails</a>.
- Coming patches are listed in <a href="https://dpdk.org/dev/patchwork">patchwork</a>.
- <p>Planned features are listed in the <a href="/dev/roadmap">roadmap</a>
- and integrated during a <a href="/dev/roadmap#cycle">cycle started by a merge window</a>.
- <p>Bugs are open in <a
- href="https://dpdk.org/tracker/buglist.cgi?bug_status=__open__&product=DPDK">bugzilla</a>.
-
- <h3 id="licenses">Licenses</h3>
- <p>Main code is BSD licensed and Linux kernel related parts are naturally licensed under the GPL.
-
- <h3 id="clone">Get source code</h3>
- <p>Read-only access:
- <pre>git clone git://dpdk.org/dpdk</pre>
- <p>Or if git is blocked in your network:
- <pre>git clone http://dpdk.org/git/dpdk</pre>
- <p>The source code can be <a href="/browse/dpdk/tree/">browsed online</a>.
- <p>Focus is on next version in git <em>HEAD</em>. There is no maintenance of previous versions.
-
- <h3 id="send">Contribute by sending patches</h3>
- <p><strong>Following lines are a snippet of
- <a href="/doc/guides/contributing/patches.html">contribution guidelines</a>.</strong>
-
- <p>Patches should be sent and reviewed via the <a href="/ml/archives/dev">mailing list</a>.
- Be sure <a href="/ml/listinfo/dev">to be registered</a>.
- <p>To prepare a patch, it must be saved with
- <a href="http://www.kernel.org/pub/software/scm/git/docs/git-commit.html">git commit</a>.
- <p>The title will be clearly visible in the
- <a href="/browse/dpdk/log">git repository</a>
- and in the <a href="/ml/archives/dev">email archives</a>.
- So it is important to make it short and clear for quick reading and searches.
- Prefixes like <em>"mk:"</em>, <em>"mem:"</em> or <em>"pci:"</em> make it easy to read.<br>
- The email title must begin with <em>[PATCH]</em> to distinguish it among discussions.
- <p>There must be details in the commit log, explaining what was the problem and how it is fixed.<br>
- When fixing a regression, it is a good idea to reference the id of
- the commit which introduced the bug (see fixline alias below).
- <p>Before sending a patch, be sure that there is no licensing issue.
- The commit log must have a <em>Signed-off-by</em> line (<em>--signoff</em> option).
- It certifies that you wrote it and/or have the right to send it.<br>
- For a longer explanation, see the
- <a href="http://developercertificate.org">Developer Certificate of Origin</a>.
- <p>The patch must be sent with
- <a href="http://www.kernel.org/pub/software/scm/git/docs/git-send-email.html">git send-email</a>.
- It is automatically or manually prepared in the right format by
- <a href="http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html">git format-patch</a>.
- Typical usage is:
- <pre>git send-email -1 --to dev@dpdk.org</pre>
- <p>If a previous version of the patch has already been sent,
- a version number and changelog annotations are helpful:
- <pre>git send-email -1 -v2 --annotate --in-reply-to &lt;Message-ID of the previous patch&gt;
---to dev@dpdk.org --cc &lt;everybody discussing the patch&gt;</pre>
- <p>Annotations take place after the 3 dashes and should explicit
- what has changed since the previous version.
- <p>The Message-ID can be found in the email header of the previous patch or in its
- <a href="/patch/14470">patchwork page</a>.
- <p>In the case of a bug reported on the mailing list, the patch should be a reply to the bug report.
- <p>An updated patchset should be a reply to the previous cover letter.
- <p>When sending several patches in a series, a cover letter may explain the global idea:
- <pre>git send-email -3 --to dev@dpdk.org --cover-letter --annotate</pre>
- <p>Shallow threading (<em>--thread --no-chain-reply-to</em>) is preferred for patch series.
- It should be git's default.
- <p>If a patch is for a <a href="/doc/guides/contributing/stable.html">stable release</a>
- rather than for mainline, please send only to stable@dpdk.org and indicate the target branch
- using <em>--subject-prefix</em>:
- <pre>git send-email -1 --to stable@dpdk.org --subject-prefix='PATCH 17.11'</pre>
- <p>Example of configuration in <em>~/.gitconfig</em>:
- <pre>[sendemail]
- suppressfrom = true
- chainreplyto = false
- confirm = always
- envelopesender = auto
- smtpuser = name@domain.com
- smtpserver = smtp.domain.com
- smtpserverport = 465
- smtpencryption = ssl
-[alias]
- fixline = log -1 --abbrev=12 --format='Fixes: %h (\"%s\")%nCc: %ae'</pre>
-
- <h3 id="review">Contribute by testing or reviewing patches</h3>
- <p>Patches are applied in the git repository when it becomes clear that
- they are well written and do the right things.<br>
- Test reports and reviews help a lot in the process.
- Such contributions are marked with flags
- <em>Tested-by</em>, <em>Reviewed-by</em> or <em>Acked-by</em>.
-
- <h3 id="patchwork">Status of patches</h3>
- <p>Once sent to the mailing list, patches are automatically registered
- in <a href="/dev/patchwork">patchwork</a> with status <em>"New"</em>.
- So they are visible in the default view (filter <em>"Action Required"</em>).
- <p>Access to management of his own patches is granted
- after <a href="https://dpdk.org/dev/patchwork/register">registration</a>.
- The status may be manually updated to <em>"RFC"</em>,
- <em>"Changes Requested"</em>, <em>"Superseded"</em> or <em>"Rejected"</em>.
- After sending a new version of a patch, developers should set
- the previous patch as <em>"Superseded"</em>.
- When a patch is applied, it is set to <em>"Accepted"</em>.
- <p>Patchwork can also help to download patches individually or bundled.
- <p>Most of the patchwork actions can be done
- with a <a href="/dev/patchwork/help/pwclient/">pwclient</a> command line.
-
- <h3 id="bugzilla">Contribute by finding or fixing bugs</h3>
- <p>There is a <a href="https://dpdk.org/tracker/">bug tracker</a> where
- anybody can notify a bug to the community, and follow the resolution.
- <p>A notification is sent to dev@dpdk.org for every new bug.
- The fixes must be sent and discussed on the mailing list.
-
- <h3 id="board">Technical Board</h3>
- <p>The Technical Board may intermediate in the development process,
- as described in the <a href="/about/techboard">Technical Board operation</a>.
-
-</section>
-<footer></footer>