diff options
Diffstat (limited to 'Documentation/process')
| -rw-r--r-- | Documentation/process/1.Intro.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/4.Coding.rst | 3 | ||||
| -rw-r--r-- | Documentation/process/5.Posting.rst | 23 | ||||
| -rw-r--r-- | Documentation/process/8.Conclusion.rst | 7 | ||||
| -rw-r--r-- | Documentation/process/adding-syscalls.rst | 3 | ||||
| -rw-r--r-- | Documentation/process/changes.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/coding-style.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/howto.rst | 13 | ||||
| -rw-r--r-- | Documentation/process/kernel-driver-statement.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/kernel-enforcement-statement.rst | 4 | ||||
| -rw-r--r-- | Documentation/process/magic-number.rst | 2 | ||||
| -rw-r--r-- | Documentation/process/management-style.rst | 5 | ||||
| -rw-r--r-- | Documentation/process/submitting-drivers.rst | 8 |
13 files changed, 49 insertions, 27 deletions
diff --git a/Documentation/process/1.Intro.rst b/Documentation/process/1.Intro.rst index e782ae2eef58..c3d0270bbfb3 100644 --- a/Documentation/process/1.Intro.rst +++ b/Documentation/process/1.Intro.rst | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | .. _development_process_intro: | ||
| 2 | |||
| 1 | Introduction | 3 | Introduction |
| 2 | ============ | 4 | ============ |
| 3 | 5 | ||
diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst index eb4b185d168c..cfe264889447 100644 --- a/Documentation/process/4.Coding.rst +++ b/Documentation/process/4.Coding.rst | |||
| @@ -315,7 +315,8 @@ variety of potential coding problems; it can also propose fixes for those | |||
| 315 | problems. Quite a few "semantic patches" for the kernel have been packaged | 315 | problems. Quite a few "semantic patches" for the kernel have been packaged |
| 316 | under the scripts/coccinelle directory; running "make coccicheck" will run | 316 | under the scripts/coccinelle directory; running "make coccicheck" will run |
| 317 | through those semantic patches and report on any problems found. See | 317 | through those semantic patches and report on any problems found. See |
| 318 | Documentation/dev-tools/coccinelle.rst for more information. | 318 | :ref:`Documentation/dev-tools/coccinelle.rst <devtools_coccinelle>` |
| 319 | for more information. | ||
| 319 | 320 | ||
| 320 | Other kinds of portability errors are best found by compiling your code for | 321 | Other kinds of portability errors are best found by compiling your code for |
| 321 | other architectures. If you do not happen to have an S/390 system or a | 322 | other architectures. If you do not happen to have an S/390 system or a |
diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst index c418c5d6cae4..4213e580f273 100644 --- a/Documentation/process/5.Posting.rst +++ b/Documentation/process/5.Posting.rst | |||
| @@ -9,9 +9,10 @@ kernel. Unsurprisingly, the kernel development community has evolved a set | |||
| 9 | of conventions and procedures which are used in the posting of patches; | 9 | of conventions and procedures which are used in the posting of patches; |
| 10 | following them will make life much easier for everybody involved. This | 10 | following them will make life much easier for everybody involved. This |
| 11 | document will attempt to cover these expectations in reasonable detail; | 11 | document will attempt to cover these expectations in reasonable detail; |
| 12 | more information can also be found in the files process/submitting-patches.rst, | 12 | more information can also be found in the files |
| 13 | process/submitting-drivers.rst, and process/submit-checklist.rst in the kernel | 13 | :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`, |
| 14 | documentation directory. | 14 | :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>` |
| 15 | and :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`. | ||
| 15 | 16 | ||
| 16 | 17 | ||
| 17 | When to post | 18 | When to post |
| @@ -198,8 +199,10 @@ pass it to diff with the "-X" option. | |||
| 198 | 199 | ||
| 199 | The tags mentioned above are used to describe how various developers have | 200 | The tags mentioned above are used to describe how various developers have |
| 200 | been associated with the development of this patch. They are described in | 201 | been associated with the development of this patch. They are described in |
| 201 | detail in the process/submitting-patches.rst document; what follows here is a | 202 | detail in |
| 202 | brief summary. Each of these lines has the format: | 203 | the :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` |
| 204 | document; what follows here is a brief summary. Each of these lines has | ||
| 205 | the format: | ||
| 203 | 206 | ||
| 204 | :: | 207 | :: |
| 205 | 208 | ||
| @@ -210,8 +213,8 @@ The tags in common use are: | |||
| 210 | - Signed-off-by: this is a developer's certification that he or she has | 213 | - Signed-off-by: this is a developer's certification that he or she has |
| 211 | the right to submit the patch for inclusion into the kernel. It is an | 214 | the right to submit the patch for inclusion into the kernel. It is an |
| 212 | agreement to the Developer's Certificate of Origin, the full text of | 215 | agreement to the Developer's Certificate of Origin, the full text of |
| 213 | which can be found in Documentation/process/submitting-patches.rst. Code | 216 | which can be found in :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` |
| 214 | without a proper signoff cannot be merged into the mainline. | 217 | Code without a proper signoff cannot be merged into the mainline. |
| 215 | 218 | ||
| 216 | - Co-developed-by: states that the patch was also created by another developer | 219 | - Co-developed-by: states that the patch was also created by another developer |
| 217 | along with the original author. This is useful at times when multiple | 220 | along with the original author. This is useful at times when multiple |
| @@ -226,7 +229,7 @@ The tags in common use are: | |||
| 226 | it to work. | 229 | it to work. |
| 227 | 230 | ||
| 228 | - Reviewed-by: the named developer has reviewed the patch for correctness; | 231 | - Reviewed-by: the named developer has reviewed the patch for correctness; |
| 229 | see the reviewer's statement in Documentation/process/submitting-patches.rst | 232 | see the reviewer's statement in :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` |
| 230 | for more detail. | 233 | for more detail. |
| 231 | 234 | ||
| 232 | - Reported-by: names a user who reported a problem which is fixed by this | 235 | - Reported-by: names a user who reported a problem which is fixed by this |
| @@ -253,8 +256,8 @@ take care of: | |||
| 253 | be examined in any detail. If there is any doubt at all, mail the patch | 256 | be examined in any detail. If there is any doubt at all, mail the patch |
| 254 | to yourself and convince yourself that it shows up intact. | 257 | to yourself and convince yourself that it shows up intact. |
| 255 | 258 | ||
| 256 | Documentation/process/email-clients.rst has some helpful hints on making | 259 | :ref:`Documentation/process/email-clients.rst <email_clients>` has some |
| 257 | specific mail clients work for sending patches. | 260 | helpful hints on making specific mail clients work for sending patches. |
| 258 | 261 | ||
| 259 | - Are you sure your patch is free of silly mistakes? You should always | 262 | - Are you sure your patch is free of silly mistakes? You should always |
| 260 | run patches through scripts/checkpatch.pl and address the complaints it | 263 | run patches through scripts/checkpatch.pl and address the complaints it |
diff --git a/Documentation/process/8.Conclusion.rst b/Documentation/process/8.Conclusion.rst index 1c7f54cd0261..8395aa2c1f3a 100644 --- a/Documentation/process/8.Conclusion.rst +++ b/Documentation/process/8.Conclusion.rst | |||
| @@ -5,9 +5,10 @@ For more information | |||
| 5 | 5 | ||
| 6 | There are numerous sources of information on Linux kernel development and | 6 | There are numerous sources of information on Linux kernel development and |
| 7 | related topics. First among those will always be the Documentation | 7 | related topics. First among those will always be the Documentation |
| 8 | directory found in the kernel source distribution. The top-level process/howto.rst | 8 | directory found in the kernel source distribution. The top-level :ref:`process/howto.rst <process_howto>` |
| 9 | file is an important starting point; process/submitting-patches.rst and | 9 | file is an important starting point; :ref:`process/submitting-patches.rst <submittingpatches>` |
| 10 | process/submitting-drivers.rst are also something which all kernel developers should | 10 | and :ref:`process/submitting-drivers.rst <submittingdrivers>` |
| 11 | are also something which all kernel developers should | ||
| 11 | read. Many internal kernel APIs are documented using the kerneldoc | 12 | read. Many internal kernel APIs are documented using the kerneldoc |
| 12 | mechanism; "make htmldocs" or "make pdfdocs" can be used to generate those | 13 | mechanism; "make htmldocs" or "make pdfdocs" can be used to generate those |
| 13 | documents in HTML or PDF format (though the version of TeX shipped by some | 14 | documents in HTML or PDF format (though the version of TeX shipped by some |
diff --git a/Documentation/process/adding-syscalls.rst b/Documentation/process/adding-syscalls.rst index 88a7d5c8bb2f..1c3a840d06b9 100644 --- a/Documentation/process/adding-syscalls.rst +++ b/Documentation/process/adding-syscalls.rst | |||
| @@ -1,3 +1,6 @@ | |||
| 1 | |||
| 2 | .. _addsyscalls: | ||
| 3 | |||
| 1 | Adding a New System Call | 4 | Adding a New System Call |
| 2 | ======================== | 5 | ======================== |
| 3 | 6 | ||
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index d1bf143b446f..18735dc460a0 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst | |||
| @@ -326,7 +326,7 @@ Kernel documentation | |||
| 326 | Sphinx | 326 | Sphinx |
| 327 | ------ | 327 | ------ |
| 328 | 328 | ||
| 329 | Please see :ref:`sphinx_install` in ``Documentation/doc-guide/sphinx.rst`` | 329 | Please see :ref:`sphinx_install` in :ref:`Documentation/doc-guide/sphinx.rst <sphinxdoc>` |
| 330 | for details about Sphinx requirements. | 330 | for details about Sphinx requirements. |
| 331 | 331 | ||
| 332 | Getting updated software | 332 | Getting updated software |
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst index 4e7c0a1c427a..277c113376a6 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst | |||
| @@ -1075,5 +1075,5 @@ gcc internals and indent, all available from http://www.gnu.org/manual/ | |||
| 1075 | WG14 is the international standardization working group for the programming | 1075 | WG14 is the international standardization working group for the programming |
| 1076 | language C, URL: http://www.open-std.org/JTC1/SC22/WG14/ | 1076 | language C, URL: http://www.open-std.org/JTC1/SC22/WG14/ |
| 1077 | 1077 | ||
| 1078 | Kernel process/coding-style.rst, by greg@kroah.com at OLS 2002: | 1078 | Kernel :ref:`process/coding-style.rst <codingstyle>`, by greg@kroah.com at OLS 2002: |
| 1079 | http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/ | 1079 | http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/ |
diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst index dcb25f94188e..58b2f46c4f98 100644 --- a/Documentation/process/howto.rst +++ b/Documentation/process/howto.rst | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | .. _process_howto: | ||
| 2 | |||
| 1 | HOWTO do Linux kernel development | 3 | HOWTO do Linux kernel development |
| 2 | ================================= | 4 | ================================= |
| 3 | 5 | ||
| @@ -296,9 +298,9 @@ two weeks, but it can be longer if there are no pressing problems. A | |||
| 296 | security-related problem, instead, can cause a release to happen almost | 298 | security-related problem, instead, can cause a release to happen almost |
| 297 | instantly. | 299 | instantly. |
| 298 | 300 | ||
| 299 | The file Documentation/process/stable-kernel-rules.rst in the kernel tree | 301 | The file :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>` |
| 300 | documents what kinds of changes are acceptable for the -stable tree, and | 302 | in the kernel tree documents what kinds of changes are acceptable for |
| 301 | how the release process works. | 303 | the -stable tree, and how the release process works. |
| 302 | 304 | ||
| 303 | 4.x -git patches | 305 | 4.x -git patches |
| 304 | ~~~~~~~~~~~~~~~~ | 306 | ~~~~~~~~~~~~~~~~ |
| @@ -358,7 +360,8 @@ tool. For details on how to use the kernel bugzilla, please see: | |||
| 358 | 360 | ||
| 359 | https://bugzilla.kernel.org/page.cgi?id=faq.html | 361 | https://bugzilla.kernel.org/page.cgi?id=faq.html |
| 360 | 362 | ||
| 361 | The file admin-guide/reporting-bugs.rst in the main kernel source directory has a good | 363 | The file :ref:`admin-guide/reporting-bugs.rst <reportingbugs>` |
| 364 | in the main kernel source directory has a good | ||
| 362 | template for how to report a possible kernel bug, and details what kind | 365 | template for how to report a possible kernel bug, and details what kind |
| 363 | of information is needed by the kernel developers to help track down the | 366 | of information is needed by the kernel developers to help track down the |
| 364 | problem. | 367 | problem. |
| @@ -424,7 +427,7 @@ add your statements between the individual quoted sections instead of | |||
| 424 | writing at the top of the mail. | 427 | writing at the top of the mail. |
| 425 | 428 | ||
| 426 | If you add patches to your mail, make sure they are plain readable text | 429 | If you add patches to your mail, make sure they are plain readable text |
| 427 | as stated in Documentation/process/submitting-patches.rst. | 430 | as stated in :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`. |
| 428 | Kernel developers don't want to deal with | 431 | Kernel developers don't want to deal with |
| 429 | attachments or compressed patches; they may want to comment on | 432 | attachments or compressed patches; they may want to comment on |
| 430 | individual lines of your patch, which works only that way. Make sure you | 433 | individual lines of your patch, which works only that way. Make sure you |
diff --git a/Documentation/process/kernel-driver-statement.rst b/Documentation/process/kernel-driver-statement.rst index e78452c2164c..a849790a68bc 100644 --- a/Documentation/process/kernel-driver-statement.rst +++ b/Documentation/process/kernel-driver-statement.rst | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | .. _process_statement_driver: | ||
| 2 | |||
| 1 | Kernel Driver Statement | 3 | Kernel Driver Statement |
| 2 | ----------------------- | 4 | ----------------------- |
| 3 | 5 | ||
diff --git a/Documentation/process/kernel-enforcement-statement.rst b/Documentation/process/kernel-enforcement-statement.rst index 6816c12d6956..e5a1be476047 100644 --- a/Documentation/process/kernel-enforcement-statement.rst +++ b/Documentation/process/kernel-enforcement-statement.rst | |||
| @@ -1,4 +1,6 @@ | |||
| 1 | Linux Kernel Enforcement Statement | 1 | .. _process_statement_kernel: |
| 2 | |||
| 3 | Linux Kernel Enforcement Statement | ||
| 2 | ---------------------------------- | 4 | ---------------------------------- |
| 3 | 5 | ||
| 4 | As developers of the Linux kernel, we have a keen interest in how our software | 6 | As developers of the Linux kernel, we have a keen interest in how our software |
diff --git a/Documentation/process/magic-number.rst b/Documentation/process/magic-number.rst index 633be1043690..547bbf28e615 100644 --- a/Documentation/process/magic-number.rst +++ b/Documentation/process/magic-number.rst | |||
| @@ -1,3 +1,5 @@ | |||
| 1 | .. _magicnumbers: | ||
| 2 | |||
| 1 | Linux magic numbers | 3 | Linux magic numbers |
| 2 | =================== | 4 | =================== |
| 3 | 5 | ||
diff --git a/Documentation/process/management-style.rst b/Documentation/process/management-style.rst index 85ef8ca8f639..186753ff3d2d 100644 --- a/Documentation/process/management-style.rst +++ b/Documentation/process/management-style.rst | |||
| @@ -5,8 +5,9 @@ Linux kernel management style | |||
| 5 | 5 | ||
| 6 | This is a short document describing the preferred (or made up, depending | 6 | This is a short document describing the preferred (or made up, depending |
| 7 | on who you ask) management style for the linux kernel. It's meant to | 7 | on who you ask) management style for the linux kernel. It's meant to |
| 8 | mirror the process/coding-style.rst document to some degree, and mainly written to | 8 | mirror the :ref:`process/coding-style.rst <codingstyle>` document to some |
| 9 | avoid answering [#f1]_ the same (or similar) questions over and over again. | 9 | degree, and mainly written to avoid answering [#f1]_ the same (or similar) |
| 10 | questions over and over again. | ||
| 10 | 11 | ||
| 11 | Management style is very personal and much harder to quantify than | 12 | Management style is very personal and much harder to quantify than |
| 12 | simple coding style rules, so this document may or may not have anything | 13 | simple coding style rules, so this document may or may not have anything |
diff --git a/Documentation/process/submitting-drivers.rst b/Documentation/process/submitting-drivers.rst index b38bf2054ce3..58bc047e7b95 100644 --- a/Documentation/process/submitting-drivers.rst +++ b/Documentation/process/submitting-drivers.rst | |||
| @@ -16,7 +16,8 @@ you should probably talk to XFree86 (http://www.xfree86.org/) and/or X.Org | |||
| 16 | 16 | ||
| 17 | Oh, and we don't really recommend submitting changes to XFree86 :) | 17 | Oh, and we don't really recommend submitting changes to XFree86 :) |
| 18 | 18 | ||
| 19 | Also read the Documentation/process/submitting-patches.rst document. | 19 | Also read the :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` |
| 20 | document. | ||
| 20 | 21 | ||
| 21 | 22 | ||
| 22 | Allocating Device Numbers | 23 | Allocating Device Numbers |
| @@ -27,7 +28,8 @@ by the Linux assigned name and number authority (currently this is | |||
| 27 | Torben Mathiasen). The site is http://www.lanana.org/. This | 28 | Torben Mathiasen). The site is http://www.lanana.org/. This |
| 28 | also deals with allocating numbers for devices that are not going to | 29 | also deals with allocating numbers for devices that are not going to |
| 29 | be submitted to the mainstream kernel. | 30 | be submitted to the mainstream kernel. |
| 30 | See Documentation/admin-guide/devices.rst for more information on this. | 31 | See :ref:`Documentation/admin-guide/devices.rst <admin_devices>` |
| 32 | for more information on this. | ||
| 31 | 33 | ||
| 32 | If you don't use assigned numbers then when your device is submitted it will | 34 | If you don't use assigned numbers then when your device is submitted it will |
| 33 | be given an assigned number even if that is different from values you may | 35 | be given an assigned number even if that is different from values you may |
| @@ -117,7 +119,7 @@ PM support: | |||
| 117 | anything. For the driver testing instructions see | 119 | anything. For the driver testing instructions see |
| 118 | Documentation/power/drivers-testing.txt and for a relatively | 120 | Documentation/power/drivers-testing.txt and for a relatively |
| 119 | complete overview of the power management issues related to | 121 | complete overview of the power management issues related to |
| 120 | drivers see Documentation/driver-api/pm/devices.rst. | 122 | drivers see :ref:`Documentation/driver-api/pm/devices.rst <driverapi_pm_devices>`. |
| 121 | 123 | ||
| 122 | Control: | 124 | Control: |
| 123 | In general if there is active maintenance of a driver by | 125 | In general if there is active maintenance of a driver by |
