@@ -4,7 +4,7 @@ How to Submit Patches for Open vSwitch
44Send changes to Open vSwitch as patches to dev@openvswitch.org .
55One patch per email, please. More details are included below.
66
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
88the mechanics described below for you.
99
1010Before You Start
@@ -13,59 +13,59 @@ Before You Start
1313Before you send patches at all, make sure that each patch makes sense.
1414In particular:
1515
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.)
2020
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.
2424
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.
2727
2828Testing is also important:
2929
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.
3232
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.
3737
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.
4040
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.
4343
4444If you are using GitHub, then you may utilize the travis-ci.org CI build
4545system by linking your GitHub repository to it. This will run some of
4646the 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.
4949
5050Email Subject
5151-------------
5252
5353The subject line of your email should be in the following format:
54- [PATCH <n>/<m>] <area>: <summary>
54+ ` [PATCH <n>/<m>] <area>: <summary> `
5555
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.
6060
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.
6565
66- - <summary> briefly describes the change.
66+ - ` <summary> ` briefly describes the change.
6767
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
6969of the commit's change log message.
7070
7171Description
@@ -80,15 +80,15 @@ Please limit lines in the description to 79 characters in width.
8080
8181The description should include:
8282
83- - The rationale for the change.
83+ - The rationale for the change.
8484
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).
8787
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).
9090
91- - Tags (see below).
91+ - Tags (see below).
9292
9393There is no need to describe what the patch actually changed, if the
9494reader can see it for himself.
@@ -100,7 +100,7 @@ datapath names.)'.
100100
101101If you, the person sending the patch, did not write the patch
102102yourself, 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
104104will automatically cause the named author to be credited with
105105authorship in the repository.
106106
@@ -254,7 +254,7 @@ Comments
254254
255255If you want to include any comments in your email that should not be
256256part 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
258258helpful to include a diffstat here for changes that touch multiple
259259files.
260260
@@ -264,9 +264,9 @@ Patch
264264The patch should be in the body of the email following the description,
265265separated by a blank line.
266266
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
270270copies files. Quilt (http://savannah.nongnu.org/projects/quilt ) might
271271be useful if you do not want to use Git.
272272
@@ -278,12 +278,13 @@ If you cannot convince your email client not to mangle patches, then
278278sending the patch as an attachment is a second choice.
279279
280280Please 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.
283283
284284Example
285285-------
286286
287+ ```
287288From fa29a1c2c17682879e79a21bb0cdd5bbe67fa7c0 Mon Sep 17 00:00:00 2001
288289From: Jesse Gross <jesse@nicira.com>
289290Date: Thu, 8 Dec 2011 13:17:24 -0800
@@ -313,4 +314,5 @@ index fdd952e..f6cb88e 100644
313314 both_modules += brcompat
314315--
3153161.7.7.3
317+ ```
316318
0 commit comments