@@ -4,7 +4,7 @@ How to Submit Patches for Open vSwitch
4
4
Send changes to Open vSwitch as patches to
[email protected] .
5
5
One patch per email, please. More details are included below.
6
6
7
- If you are using Git, then " git format-patch" takes care of most of
7
+ If you are using Git, then ` git format-patch ` takes care of most of
8
8
the mechanics described below for you.
9
9
10
10
Before You Start
@@ -13,59 +13,59 @@ Before You Start
13
13
Before you send patches at all, make sure that each patch makes sense.
14
14
In particular:
15
15
16
- - A given patch should not break anything, even if later
17
- patches fix the problems that it causes. The source tree
18
- should still build and work after each patch is applied.
19
- (This enables " git bisect" to work best.)
16
+ - A given patch should not break anything, even if later
17
+ patches fix the problems that it causes. The source tree
18
+ should still build and work after each patch is applied.
19
+ (This enables ` git bisect ` to work best.)
20
20
21
- - A patch should make one logical change. Don't make
22
- multiple, logically unconnected changes to disparate
23
- subsystems in a single patch.
21
+ - A patch should make one logical change. Don't make
22
+ multiple, logically unconnected changes to disparate
23
+ subsystems in a single patch.
24
24
25
- - A patch that adds or removes user-visible features should
26
- also update the appropriate user documentation or manpages.
25
+ - A patch that adds or removes user-visible features should
26
+ also update the appropriate user documentation or manpages.
27
27
28
28
Testing is also important:
29
29
30
- - A patch that adds or deletes files should be tested with
31
- " make distcheck" before submission.
30
+ - A patch that adds or deletes files should be tested with
31
+ ` make distcheck ` before submission.
32
32
33
- - A patch that modifies Linux kernel code should be at least
34
- build-tested on various Linux kernel versions before
35
- submission. I suggest versions 2.6.32 and whatever
36
- the current latest release version is at the time.
33
+ - A patch that modifies Linux kernel code should be at least
34
+ build-tested on various Linux kernel versions before
35
+ submission. I suggest versions 2.6.32 and whatever
36
+ the current latest release version is at the time.
37
37
38
- - A patch that modifies the ofproto or vswitchd code should be
39
- tested in at least simple cases before submission.
38
+ - A patch that modifies the ofproto or vswitchd code should be
39
+ tested in at least simple cases before submission.
40
40
41
- - A patch that modifies xenserver code should be tested on
42
- XenServer before submission.
41
+ - A patch that modifies xenserver code should be tested on
42
+ XenServer before submission.
43
43
44
44
If you are using GitHub, then you may utilize the travis-ci.org CI build
45
45
system by linking your GitHub repository to it. This will run some of
46
46
the above tests automatically when you push changes to your repository.
47
- See the "Continuous Integration with Travis-CI" in the INSTALL file for
48
- details on how to set it up.
47
+ See the "Continuous Integration with Travis-CI" in the [ INSTALL] ( INSTALL.md )
48
+ file for details on how to set it up.
49
49
50
50
Email Subject
51
51
-------------
52
52
53
53
The subject line of your email should be in the following format:
54
- [PATCH <n>/<m>] <area>: <summary>
54
+ ` [PATCH <n>/<m>] <area>: <summary> `
55
55
56
- - [PATCH <n>/<m>] indicates that this is the nth of a series
57
- of m patches. It helps reviewers to read patches in the
58
- correct order. You may omit this prefix if you are sending
59
- only one patch.
56
+ - ` [PATCH <n>/<m>] ` indicates that this is the nth of a series
57
+ of m patches. It helps reviewers to read patches in the
58
+ correct order. You may omit this prefix if you are sending
59
+ only one patch.
60
60
61
- - <area>: indicates the area of the Open vSwitch to which the
62
- change applies (often the name of a source file or a
63
- directory). You may omit it if the change crosses multiple
64
- distinct pieces of code.
61
+ - ` <area>: ` indicates the area of the Open vSwitch to which the
62
+ change applies (often the name of a source file or a
63
+ directory). You may omit it if the change crosses multiple
64
+ distinct pieces of code.
65
65
66
- - <summary> briefly describes the change.
66
+ - ` <summary> ` briefly describes the change.
67
67
68
- The subject, minus the [PATCH <n>/<m>] prefix, becomes the first line
68
+ The subject, minus the ` [PATCH <n>/<m>] ` prefix, becomes the first line
69
69
of the commit's change log message.
70
70
71
71
Description
@@ -80,15 +80,15 @@ Please limit lines in the description to 79 characters in width.
80
80
81
81
The description should include:
82
82
83
- - The rationale for the change.
83
+ - The rationale for the change.
84
84
85
- - Design description and rationale (but this might be better
86
- added as code comments).
85
+ - Design description and rationale (but this might be better
86
+ added as code comments).
87
87
88
- - Testing that you performed (or testing that should be done
89
- but you could not for whatever reason).
88
+ - Testing that you performed (or testing that should be done
89
+ but you could not for whatever reason).
90
90
91
- - Tags (see below).
91
+ - Tags (see below).
92
92
93
93
There is no need to describe what the patch actually changed, if the
94
94
reader can see it for himself.
@@ -100,7 +100,7 @@ datapath names.)'.
100
100
101
101
If you, the person sending the patch, did not write the patch
102
102
yourself, then the very first line of the body should take the form
103
- " From: <author name> <author email>" , followed by a blank line. This
103
+ ` From: <author name> <author email> ` , followed by a blank line. This
104
104
will automatically cause the named author to be credited with
105
105
authorship in the repository.
106
106
@@ -254,7 +254,7 @@ Comments
254
254
255
255
If you want to include any comments in your email that should not be
256
256
part of the commit's change log message, put them after the
257
- description, separated by a line that contains just " ---" . It may be
257
+ description, separated by a line that contains just ` --- ` . It may be
258
258
helpful to include a diffstat here for changes that touch multiple
259
259
files.
260
260
@@ -264,9 +264,9 @@ Patch
264
264
The patch should be in the body of the email following the description,
265
265
separated by a blank line.
266
266
267
- Patches should be in " diff -up" format. We recommend that you use Git
268
- to produce your patches, in which case you should use the -M -C
269
- options to " git diff" (or other Git tools) if your patch renames or
267
+ Patches should be in ` diff -up ` format. We recommend that you use Git
268
+ to produce your patches, in which case you should use the ` -M -C `
269
+ options to ` git diff ` (or other Git tools) if your patch renames or
270
270
copies files. Quilt (http://savannah.nongnu.org/projects/quilt ) might
271
271
be useful if you do not want to use Git.
272
272
@@ -278,12 +278,13 @@ If you cannot convince your email client not to mangle patches, then
278
278
sending the patch as an attachment is a second choice.
279
279
280
280
Please follow the style used in the code that you are modifying. The
281
- CodingStyle file describes the coding style used in most of Open
282
- vSwitch. Use Linux kernel coding style for Linux kernel code.
281
+ [ CodingStyle] ( CodingStyle.md ) file describes the coding style used in
282
+ most of Open vSwitch. Use Linux kernel coding style for Linux kernel code.
283
283
284
284
Example
285
285
-------
286
286
287
+ ```
287
288
From fa29a1c2c17682879e79a21bb0cdd5bbe67fa7c0 Mon Sep 17 00:00:00 2001
288
289
From: Jesse Gross <[email protected] >
289
290
Date: Thu, 8 Dec 2011 13:17:24 -0800
@@ -313,4 +314,5 @@ index fdd952e..f6cb88e 100644
313
314
both_modules += brcompat
314
315
--
315
316
1.7.7.3
317
+ ```
316
318
0 commit comments