Blame view

Documentation/networking/netdev-FAQ.txt 10.1 KB
49dfe7626   Paul Gortmaker   Documentation: ad...
1
2
3
4
5
  
  Information you need to know about netdev
  -----------------------------------------
  
  Q: What is netdev?
ad86de802   Randy Dunlap   Documentation/net...
6
  A: It is a mailing list for all network-related Linux stuff.  This includes
49dfe7626   Paul Gortmaker   Documentation: ad...
7
     anything found under net/  (i.e. core code like IPv6) and drivers/net
ad86de802   Randy Dunlap   Documentation/net...
8
     (i.e. hardware specific drivers) in the Linux source tree.
49dfe7626   Paul Gortmaker   Documentation: ad...
9
10
11
  
     Note that some subsystems (e.g. wireless drivers) which have a high volume
     of traffic have their own specific mailing lists.
ad86de802   Randy Dunlap   Documentation/net...
12
     The netdev list is managed (like many other Linux mailing lists) through
49dfe7626   Paul Gortmaker   Documentation: ad...
13
14
15
16
     VGER ( http://vger.kernel.org/ ) and archives can be found below:
  
  	http://marc.info/?l=linux-netdev
  	http://www.spinics.net/lists/netdev/
ad86de802   Randy Dunlap   Documentation/net...
17
18
     Aside from subsystems like that mentioned above, all network-related Linux
     development (i.e. RFC, review, comments, etc.) takes place on netdev.
49dfe7626   Paul Gortmaker   Documentation: ad...
19

ad86de802   Randy Dunlap   Documentation/net...
20
  Q: How do the changes posted to netdev make their way into Linux?
49dfe7626   Paul Gortmaker   Documentation: ad...
21
22
23
24
25
26
27
  
  A: There are always two trees (git repositories) in play.  Both are driven
     by David Miller, the main network maintainer.  There is the "net" tree,
     and the "net-next" tree.  As you can probably guess from the names, the
     net tree is for fixes to existing code already in the mainline tree from
     Linus, and net-next is where the new code goes for the future release.
     You can find the trees here:
f56f7d2e1   Alexander Alemayhu   Documentation/net...
28
29
          https://git.kernel.org/pub/scm/linux/kernel/git/davem/net.git
          https://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next.git
49dfe7626   Paul Gortmaker   Documentation: ad...
30
31
32
33
  
  Q: How often do changes from these trees make it to the mainline Linus tree?
  
  A: To understand this, you need to know a bit of background information
ad86de802   Randy Dunlap   Documentation/net...
34
     on the cadence of Linux development.  Each new release starts off with
49dfe7626   Paul Gortmaker   Documentation: ad...
35
36
37
38
39
40
41
42
43
     a two week "merge window" where the main maintainers feed their new
     stuff to Linus for merging into the mainline tree.  After the two weeks,
     the merge window is closed, and it is called/tagged "-rc1".  No new
     features get mainlined after this -- only fixes to the rc1 content
     are expected.  After roughly a week of collecting fixes to the rc1
     content, rc2 is released.  This repeats on a roughly weekly basis
     until rc7 (typically; sometimes rc6 if things are quiet, or rc8 if
     things are in a state of churn), and a week after the last vX.Y-rcN
     was done, the official "vX.Y" is released.
ad86de802   Randy Dunlap   Documentation/net...
44
     Relating that to netdev:  At the beginning of the 2-week merge window,
49dfe7626   Paul Gortmaker   Documentation: ad...
45
46
47
48
49
50
51
52
53
54
55
     the net-next tree will be closed - no new changes/features.  The
     accumulated new content of the past ~10 weeks will be passed onto
     mainline/Linus via a pull request for vX.Y -- at the same time,
     the "net" tree will start accumulating fixes for this pulled content
     relating to vX.Y
  
     An announcement indicating when net-next has been closed is usually
     sent to netdev, but knowing the above, you can predict that in advance.
  
     IMPORTANT:  Do not send new net-next content to netdev during the
     period during which net-next tree is closed.
ad86de802   Randy Dunlap   Documentation/net...
56
     Shortly after the two weeks have passed (and vX.Y-rc1 is released), the
49dfe7626   Paul Gortmaker   Documentation: ad...
57
58
59
60
     tree for net-next reopens to collect content for the next (vX.Y+1) release.
  
     If you aren't subscribed to netdev and/or are simply unsure if net-next
     has re-opened yet, simply check the net-next git repository link above for
ad86de802   Randy Dunlap   Documentation/net...
61
     any new networking-related commits.
49dfe7626   Paul Gortmaker   Documentation: ad...
62
63
64
  
     The "net" tree continues to collect fixes for the vX.Y content, and
     is fed back to Linus at regular (~weekly) intervals.  Meaning that the
c17cb8b55   Masanari Iida   doc:net: Fix typo...
65
     focus for "net" is on stabilization and bugfixes.
49dfe7626   Paul Gortmaker   Documentation: ad...
66
67
68
69
70
71
  
     Finally, the vX.Y gets released, and the whole cycle starts over.
  
  Q: So where are we now in this cycle?
  
  A: Load the mainline (Linus) page here:
f56f7d2e1   Alexander Alemayhu   Documentation/net...
72
  	https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
49dfe7626   Paul Gortmaker   Documentation: ad...
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
  
     and note the top of the "tags" section.  If it is rc1, it is early
     in the dev cycle.  If it was tagged rc7 a week ago, then a release
     is probably imminent.
  
  Q: How do I indicate which tree (net vs. net-next) my patch should be in?
  
  A: Firstly, think whether you have a bug fix or new "next-like" content.
     Then once decided, assuming that you use git, use the prefix flag, i.e.
  
  	git format-patch --subject-prefix='PATCH net-next' start..finish
  
     Use "net" instead of "net-next" (always lower case) in the above for
     bug-fix net content.  If you don't use git, then note the only magic in
     the above is just the subject text of the outgoing e-mail, and you can
     manually change it yourself with whatever MUA you are comfortable with.
  
  Q: I sent a patch and I'm wondering what happened to it.  How can I tell
     whether it got merged?
  
  A: Start by looking at the main patchworks queue for netdev:
  
  	http://patchwork.ozlabs.org/project/netdev/list/
  
     The "State" field will tell you exactly where things are at with
     your patch.
  
  Q: The above only says "Under Review".  How can I find out more?
  
  A: Generally speaking, the patches get triaged quickly (in less than 48h).
     So be patient.  Asking the maintainer for status updates on your
     patch is a good way to ensure your patch is ignored or pushed to
     the bottom of the priority list.
  
  Q: How can I tell what patches are queued up for backporting to the
     various stable releases?
  
  A: Normally Greg Kroah-Hartman collects stable commits himself, but
     for networking, Dave collects up patches he deems critical for the
     networking subsystem, and then hands them off to Greg.
  
     There is a patchworks queue that you can see here:
  	http://patchwork.ozlabs.org/bundle/davem/stable/?state=*
  
     It contains the patches which Dave has selected, but not yet handed
     off to Greg.  If Greg already has the patch, then it will be here:
f56f7d2e1   Alexander Alemayhu   Documentation/net...
119
  	https://git.kernel.org/pub/scm/linux/kernel/git/stable/stable-queue.git
49dfe7626   Paul Gortmaker   Documentation: ad...
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  
     A quick way to find whether the patch is in this stable-queue is
     to simply clone the repo, and then git grep the mainline commit ID, e.g.
  
  	stable-queue$ git grep -l 284041ef21fdf2e
  	releases/3.0.84/ipv6-fix-possible-crashes-in-ip6_cork_release.patch
  	releases/3.4.51/ipv6-fix-possible-crashes-in-ip6_cork_release.patch
  	releases/3.9.8/ipv6-fix-possible-crashes-in-ip6_cork_release.patch
  	stable/stable-queue$
  
  Q: I see a network patch and I think it should be backported to stable.
     Should I request it via "stable@vger.kernel.org" like the references in
     the kernel's Documentation/stable_kernel_rules.txt file say?
  
  A: No, not for networking.  Check the stable queues as per above 1st to see
     if it is already queued.  If not, then send a mail to netdev, listing
     the upstream commit ID and why you think it should be a stable candidate.
  
     Before you jump to go do the above, do note that the normal stable rules
     in Documentation/stable_kernel_rules.txt still apply.  So you need to
     explicitly indicate why it is a critical fix and exactly what users are
     impacted.  In addition, you need to convince yourself that you _really_
     think it has been overlooked, vs. having been considered and rejected.
  
     Generally speaking, the longer it has had a chance to "soak" in mainline,
     the better the odds that it is an OK candidate for stable.  So scrambling
     to request a commit be added the day after it appears should be avoided.
  
  Q: I have created a network patch and I think it should be backported to
     stable.  Should I add a "Cc: stable@vger.kernel.org" like the references
     in the kernel's Documentation/ directory say?
  
  A: No.  See above answer.  In short, if you think it really belongs in
     stable, then ensure you write a decent commit log that describes who
     gets impacted by the bugfix and how it manifests itself, and when the
     bug was introduced.  If you do that properly, then the commit will
     get handled appropriately and most likely get put in the patchworks
     stable queue if it really warrants it.
  
     If you think there is some valid information relating to it being in
     stable that does _not_ belong in the commit log, then use the three
     dash marker line as described in Documentation/SubmittingPatches to
     temporarily embed that information into the patch that you send.
  
  Q: Someone said that the comment style and coding convention is different
     for the networking content.  Is this true?
  
  A: Yes, in a largely trivial way.  Instead of this:
  
  	/*
  	 * foobar blah blah blah
  	 * another line of text
  	 */
  
     it is requested that you make it look like this:
  
  	/* foobar blah blah blah
  	 * another line of text
  	 */
  
  Q: I am working in existing code that has the former comment style and not the
     latter.  Should I submit new code in the former style or the latter?
  
  A: Make it the latter style, so that eventually all code in the domain of
     netdev is of this format.
  
  Q: I found a bug that might have possible security implications or similar.
     Should I mail the main netdev maintainer off-list?
  
  A: No. The current netdev maintainer has consistently requested that people
     use the mailing lists and not reach out directly.  If you aren't OK with
     that, then perhaps consider mailing "security@kernel.org" or reading about
     http://oss-security.openwall.org/wiki/mailing-lists/distros
     as possible alternative mechanisms.
  
  Q: What level of testing is expected before I submit my change?
  
  A: If your changes are against net-next, the expectation is that you
     have tested by layering your changes on top of net-next.  Ideally you
     will have done run-time testing specific to your change, but at a
     minimum, your changes should survive an "allyesconfig" and an
     "allmodconfig" build without new warnings or failures.
  
  Q: Any other tips to help ensure my net/net-next patch gets OK'd?
  
  A: Attention to detail.  Re-read your own work as if you were the
     reviewer.  You can start with using checkpatch.pl, perhaps even
     with the "--strict" flag.  But do not be mindlessly robotic in
     doing so.  If your change is a bug-fix, make sure your commit log
     indicates the end-user visible symptom, the underlying reason as
     to why it happens, and then if necessary, explain why the fix proposed
     is the best way to get things done.   Don't mangle whitespace, and as
     is common, don't mis-indent function arguments that span multiple lines.
ad86de802   Randy Dunlap   Documentation/net...
213
     If it is your first patch, mail it to yourself so you can test apply
49dfe7626   Paul Gortmaker   Documentation: ad...
214
215
216
217
     it to an unpatched tree to confirm infrastructure didn't mangle it.
  
     Finally, go back and read Documentation/SubmittingPatches to be
     sure you are not repeating some common mistake documented there.