Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Merge branch 'netdev-docs'
Jakub Kicinski says:
====================
docs: netdev: document more of our rules
The patch series length limit and reverse xmas tree are not documented.
Add those, and a tl;dr section summarizing how we differ.
v2: improve the series length blurb (Andrew)
====================
Signed-off-by: David S. Miller <davem@davemloft.net>
+36
+36
Documentation/process/maintainer-netdev.rst
+36
Documentation/process/maintainer-netdev.rst
···
6
6
netdev FAQ
7
7
==========
8
8
9
+
tl;dr
10
+
-----
11
+
12
+
- designate your patch to a tree - ``[PATCH net]`` or ``[PATCH net-next]``
13
+
- for fixes the ``Fixes:`` tag is required, regardless of the tree
14
+
- don't post large series (> 15 patches), break them up
15
+
- don't repost your patches within one 24h period
16
+
- reverse xmas tree
17
+
9
18
What is netdev?
10
19
---------------
11
20
It is a mailing list for all network-related Linux stuff. This
···
145
136
version that should be applied. If there is any doubt, the maintainer
146
137
will reply and ask what should be done.
147
138
139
+
How do I divide my work into patches?
140
+
-------------------------------------
141
+
142
+
Put yourself in the shoes of the reviewer. Each patch is read separately
143
+
and therefore should constitute a comprehensible step towards your stated
144
+
goal.
145
+
146
+
Avoid sending series longer than 15 patches. Larger series takes longer
147
+
to review as reviewers will defer looking at it until they find a large
148
+
chunk of time. A small series can be reviewed in a short time, so Maintainers
149
+
just do it. As a result, a sequence of smaller series gets merged quicker and
150
+
with better review coverage. Re-posting large series also increases the mailing
151
+
list traffic.
152
+
148
153
I made changes to only a few patches in a patch series should I resend only those changed?
149
154
------------------------------------------------------------------------------------------
150
155
No, please resend the entire patch series and make sure you do number your
···
205
182
/* foobar blah blah blah
206
183
* another line of text
207
184
*/
185
+
186
+
What is "reverse xmas tree"?
187
+
----------------------------
188
+
189
+
Netdev has a convention for ordering local variables in functions.
190
+
Order the variable declaration lines longest to shortest, e.g.::
191
+
192
+
struct scatterlist *sg;
193
+
struct sk_buff *skb;
194
+
int err, i;
195
+
196
+
If there are dependencies between the variables preventing the ordering
197
+
move the initialization out of line.
208
198
209
199
I am working in existing code which uses non-standard formatting. Which formatting should I use?
210
200
------------------------------------------------------------------------------------------------