Documentation/SubmittingPatches

   1
   2         How to Get Your Change Into the Linux Kernel
   3                 or
   4         Care And Operation Of Your Linus Torvalds
   5
   6
   7
   8 For a person or company who wishes to submit a change to the Linux
   9 kernel, the process can sometimes be daunting if you're not familiar
  10 with "the system."  This text is a collection of suggestions which
  11 can greatly increase the chances of your change being accepted.
  12
  13 If you are submitting a driver, also read Documentation/SubmittingDrivers.
  14
  15
  16
  17 --------------------------------------------
  18 SECTION 1 - CREATING AND SENDING YOUR CHANGE
  19 --------------------------------------------
  20
  21
  22
  23 1) "diff -up"
  24 ------------
  25
  26 Use "diff -up" or "diff -uprN" to create patches.
  27
  28 All changes to the Linux kernel occur in the form of patches, as
  29 generated by diff(1).  When creating your patch, make sure to create it
  30 in "unified diff" format, as supplied by the '-u' argument to diff(1).
  31 Also, please use the '-p' argument which shows which C function each
  32 change is in - that makes the resultant diff a lot easier to read.
  33 Patches should be based in the root kernel source directory,
  34 not in any lower subdirectory.
  35
  36 To create a patch for a single file, it is often sufficient to do:
  37
  38         SRCTREE= linux-2.4
  39         MYFILE=  drivers/net/mydriver.c
  40
  41         cd $SRCTREE
  42         cp $MYFILE $MYFILE.orig
  43         vi $MYFILE      # make your change
  44         cd ..
  45         diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
  46
  47 To create a patch for multiple files, you should unpack a "vanilla",
  48 or unmodified kernel source tree, and generate a diff against your
  49 own source tree.  For example:
  50
  51         MYSRC= /devel/linux-2.4
  52
  53         tar xvfz linux-2.4.0-test11.tar.gz
  54         mv linux linux-vanilla
  55         wget http://www.moses.uklinux.net/patches/dontdiff
  56         diff -uprN -X dontdiff linux-vanilla $MYSRC > /tmp/patch
  57         rm -f dontdiff
  58
  59 "dontdiff" is a list of files which are generated by the kernel during
  60 the build process, and should be ignored in any diff(1)-generated
  61 patch.  dontdiff is maintained by Tigran Aivazian <tigran@veritas.com>
  62
  63 Make sure your patch does not include any extra files which do not
  64 belong in a patch submission.  Make sure to review your patch -after-
  65 generated it with diff(1), to ensure accuracy.
  66
  67 If your changes produce a lot of deltas, you may want to look into
  68 splitting them into individual patches which modify things in
  69 logical stages, this will facilitate easier reviewing by other
  70 kernel developers, very important if you want your patch accepted.
  71 There are a number of scripts which can aid in this;
  72
  73 Quilt:
  74 http://savannah.nongnu.org/projects/quilt
  75
  76 Randy Dunlap's patch scripts:
  77 http://developer.osdl.org/rddunlap/scripts/patching-scripts.tgz
  78
  79 Andrew Morton's patch scripts:
  80 http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.16
  81
  82 2) Describe your changes.
  83
  84 Describe the technical detail of the change(s) your patch includes.
  85
  86 Be as specific as possible.  The WORST descriptions possible include
  87 things like "update driver X", "bug fix for driver X", or "this patch
  88 includes updates for subsystem X.  Please apply."
  89
  90 If your description starts to get long, that's a sign that you probably
  91 need to split up your patch.  See #3, next.
  92
  93
  94
  95 3) Separate your changes.
  96
  97 Separate each logical change into its own patch.
  98
  99 For example, if your changes include both bug fixes and performance
 100 enhancements for a single driver, separate those changes into two
 101 or more patches.  If your changes include an API update, and a new
 102 driver which uses that new API, separate those into two patches.
 103
 104 On the other hand, if you make a single change to numerous files,
 105 group those changes into a single patch.  Thus a single logical change
 106 is contained within a single patch.
 107
 108 If one patch depends on another patch in order for a change to be
 109 complete, that is OK.  Simply note "this patch depends on patch X"
 110 in your patch description.
 111
 112
 113 4) Select e-mail destination.
 114
 115 Look through the MAINTAINERS file and the source code, and determine
 116 if your change applies to a specific subsystem of the kernel, with
 117 an assigned maintainer.  If so, e-mail that person.
 118
 119 If no maintainer is listed, or the maintainer does not respond, send
 120 your patch to the primary Linux kernel developer's mailing list,
 121 linux-kernel@vger.kernel.org.  Most kernel developers monitor this
 122 e-mail list, and can comment on your changes.
 123
 124 Linus Torvalds is the final arbiter of all changes accepted into the
 125 Linux kernel.  His e-mail address is <torvalds@osdl.org>.  He gets
 126 a lot of e-mail, so typically you should do your best to -avoid- sending
 127 him e-mail.
 128
 129 Patches which are bug fixes, are "obvious" changes, or similarly
 130 require little discussion should be sent or CC'd to Linus.  Patches
 131 which require discussion or do not have a clear advantage should
 132 usually be sent first to linux-kernel.  Only after the patch is
 133 discussed should the patch then be submitted to Linus.
 134
 135
 136
 137 5) Select your CC (e-mail carbon copy) list.
 138
 139 Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org.
 140
 141 Other kernel developers besides Linus need to be aware of your change,
 142 so that they may comment on it and offer code review and suggestions.
 143 linux-kernel is the primary Linux kernel developer mailing list.
 144 Other mailing lists are available for specific subsystems, such as
 145 USB, framebuffer devices, the VFS, the SCSI subsystem, etc.  See the
 146 MAINTAINERS file for a mailing list that relates specifically to
 147 your change.
 148
 149 Even if the maintainer did not respond in step #4, make sure to ALWAYS
 150 copy the maintainer when you change their code.
 151
 152 For small patches you may want to CC the Trivial Patch Monkey
 153 trivial@rustcorp.com.au set up by Rusty Russell; which collects "trivial"
 154 patches. Trivial patches must qualify for one of the following rules:
 155  Spelling fixes in documentation
 156  Spelling fixes which could break grep(1).
 157  Warning fixes (cluttering with useless warnings is bad)
 158  Compilation fixes (only if they are actually correct)
 159  Runtime fixes (only if they actually fix things)
 160  Removing use of deprecated functions/macros (eg. check_region).
 161  Contact detail and documentation fixes
 162  Non-portable code replaced by portable code (even in arch-specific,
 163  since people copy, as long as it's trivial)
 164  Any fix by the author/maintainer of the file. (ie. patch monkey
 165  in re-transmission mode)
 166
 167
 168
 169 6) No MIME, no links, no compression, no attachments.  Just plain text.
 170
 171 Linus and other kernel developers need to be able to read and comment
 172 on the changes you are submitting.  It is important for a kernel
 173 developer to be able to "quote" your changes, using standard e-mail
 174 tools, so that they may comment on specific portions of your code.
 175
 176 For this reason, all patches should be submitting e-mail "inline".
 177 WARNING:  Be wary of your editor's word-wrap corrupting your patch,
 178 if you choose to cut-n-paste your patch.
 179
 180 Do not attach the patch as a MIME attachment, compressed or not.
 181 Many popular e-mail applications will not always transmit a MIME
 182 attachment as plain text, making it impossible to comment on your
 183 code.  A MIME attachment also takes Linus a bit more time to process,
 184 decreasing the likelihood of your MIME-attached change being accepted.
 185
 186 Exception:  If your mailer is mangling patches then someone may ask
 187 you to re-send them using MIME.
 188
 189
 190
 191 7) E-mail size.
 192
 193 When sending patches to Linus, always follow step #6.
 194
 195 Large changes are not appropriate for mailing lists, and some
 196 maintainers.  If your patch, uncompressed, exceeds 40 kB in size,
 197 it is preferred that you store your patch on an Internet-accessible
 198 server, and provide instead a URL (link) pointing to your patch.
 199
 200
 201
 202 8) Name your kernel version.
 203
 204 It is important to note, either in the subject line or in the patch
 205 description, the kernel version to which this patch applies.
 206
 207 If the patch does not apply cleanly to the latest kernel version,
 208 Linus will not apply it.
 209
 210
 211
 212 9) Don't get discouraged.  Re-submit.
 213
 214 After you have submitted your change, be patient and wait.  If Linus
 215 likes your change and applies it, it will appear in the next version
 216 of the kernel that he releases.
 217
 218 However, if your change doesn't appear in the next version of the
 219 kernel, there could be any number of reasons.  It's YOUR job to
 220 narrow down those reasons, correct what was wrong, and submit your
 221 updated change.
 222
 223 It is quite common for Linus to "drop" your patch without comment.
 224 That's the nature of the system.  If he drops your patch, it could be
 225 due to
 226 * Your patch did not apply cleanly to the latest kernel version
 227 * Your patch was not sufficiently discussed on linux-kernel.
 228 * A style issue (see section 2),
 229 * An e-mail formatting issue (re-read this section)
 230 * A technical problem with your change
 231 * He gets tons of e-mail, and yours got lost in the shuffle
 232 * You are being annoying (See Figure 1)
 233
 234 When in doubt, solicit comments on linux-kernel mailing list.
 235
 236
 237
 238 10) Include PATCH in the subject
 239
 240 Due to high e-mail traffic to Linus, and to linux-kernel, it is common
 241 convention to prefix your subject line with [PATCH].  This lets Linus
 242 and other kernel developers more easily distinguish patches from other
 243 e-mail discussions.
 244
 245
 246
 247 -----------------------------------
 248 SECTION 2 - HINTS, TIPS, AND TRICKS
 249 -----------------------------------
 250
 251 This section lists many of the common "rules" associated with code
 252 submitted to the kernel.  There are always exceptions... but you must
 253 have a really good reason for doing so.  You could probably call this
 254 section Linus Computer Science 101.
 255
 256
 257
 258 1) Read Documentation/CodingStyle
 259
 260 Nuff said.  If your code deviates too much from this, it is likely
 261 to be rejected without further review, and without comment.
 262
 263
 264
 265 2) #ifdefs are ugly
 266
 267 Code cluttered with ifdefs is difficult to read and maintain.  Don't do
 268 it.  Instead, put your ifdefs in a header, and conditionally define
 269 'static inline' functions, or macros, which are used in the code.
 270 Let the compiler optimize away the "no-op" case.
 271
 272 Simple example, of poor code:
 273
 274         dev = alloc_etherdev (sizeof(struct funky_private));
 275         if (!dev)
 276                 return -ENODEV;
 277         #ifdef CONFIG_NET_FUNKINESS
 278         init_funky_net(dev);
 279         #endif
 280
 281 Cleaned-up example:
 282
 283 (in header)
 284         #ifndef CONFIG_NET_FUNKINESS
 285         static inline void init_funky_net (struct net_device *d) {}
 286         #endif
 287
 288 (in the code itself)
 289         dev = alloc_etherdev (sizeof(struct funky_private));
 290         if (!dev)
 291                 return -ENODEV;
 292         init_funky_net(dev);
 293
 294
 295
 296 3) 'static inline' is better than a macro
 297
 298 Static inline functions are greatly preferred over macros.
 299 They provide type safety, have no length limitations, no formatting
 300 limitations, and under gcc they are as cheap as macros.
 301
 302 Macros should only be used for cases where a static inline is clearly
 303 suboptimal [there a few, isolated cases of this in fast paths],
 304 or where it is impossible to use a static inline function [such as
 305 string-izing].
 306
 307 'static inline' is preferred over 'static __inline__', 'extern inline',
 308 and 'extern __inline__'.
 309
 310
 311
 312 4) Don't over-design.
 313
 314 Don't try to anticipate nebulous future cases which may or may not
 315 be useful:  "Make it as simple as you can, and no simpler"
 316
 317
 318