summaryrefslogtreecommitdiffstats
path: root/Documentation/process
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: stable-kernel-rules: fix stable-tag formatJohan Hovold2017-04-081-1/+1
| | | | | | | | | | | | | | A patch documenting how to specify which kernels a particular fix should be backported to (seemingly) inadvertently added a minus sign after the kernel version. This particular stable-tag format had never been used prior to this patch, and was neither present when the patch in question was first submitted (it was added in v2 without any comment). Drop the minus sign to avoid any confusion. Fixes: fdc81b7910ad ("stable_kernel_rules: Add clause about specification of kernel versions to patch.") Signed-off-by: Johan Hovold <johan@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Doc: Correct typo, "Introdution" => "Introduction"Sanjeev2016-12-011-2/+2
| | | | | | | | This corrects a set of spelling mistakes, probably from an automated conversion. Signed-off-by: Sanjeev Gupta <ghane0@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/atomic_ops.txt: convert to ReST markupSilvio Fricke2016-11-301-0/+3
| | | | | | | ... and move to core-api folder. Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/process/howto: Only send regression fixes after -rc1Dan Carpenter2016-11-281-9/+10
| | | | | | | | | | The original text was not clear if white space or other harmless patches should be merged in -rc kernels. The discussion at Kernel Summit said that we should be more strict about sending regression fixes only. Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: doc-guide: split the kernel-documentation.rst contentsMauro Carvalho Chehab2016-11-192-4/+4
| | | | | | | | | Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* coding-style: fix mismatch of jump label nameMasahiro Yamada2016-11-071-1/+1
| | | | | | | | | | Commit 865a1caa4b6b ("CodingStyle: Clarify and complete chapter 7") renamed the label "out_buffer" to "out_free_buffer", but missed to change this line. Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/process/howto: Mark subsection in suggested formatSeongJae Park2016-11-071-5/+10
| | | | | | | | | | `Specific guidelines for the kernel documentation` section of `kernel-documentation.rst` suggests to use ``~`` for subsection but subsections in HOWTO is not marked in the format. This commit marks them in the format. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'doc-tweaks' into docs-nextJonathan Corbet2016-10-275-23/+48
|\ | | | | | | | | | | | | | | The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
| * docs: Add a warning to applying-patches.rstJonathan Corbet2016-10-271-0/+4
| | | | | | | | | | | | | | | | This is ancient stuff and we don't do things this way anymore. In the absence of simply deleting the document, at least add a warning to it. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: add a warning to submitting-drivers.rstJonathan Corbet2016-10-271-0/+8
| | | | | | | | | | | | | | | | This is crufty stuff and should maybe just be deleted, but I'm not quite ready to do that yet. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Collapse the process guide TOCJonathan Corbet2016-10-271-3/+3
| | | | | | | | | | | | | | I believe this makes the page as a whole more approachable. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Tweak submitting-patches.rst formattingJonathan Corbet2016-10-271-10/+6
| | | | | | | | | | | | | | | | | | The main goal here was to get the subsections to show in the TOC as they do for all the other documents. Also call out the DCO in the section title since it's important. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Apply some basic organization to the process guideJonathan Corbet2016-10-272-10/+29
| | | | | | | | | | | | | | | | Put like documents together, with the essential ones at the top, and split the TOC into sections. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-rst: include index only in subproject AND htmlMarkus Heiser2016-10-261-0/+8
|/ | | | | | | | The index should only be included if the build of the sub-folder is done with the html-builder (HTML output). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: fix locations of several documents that got movedMauro Carvalho Chehab2016-10-2411-42/+42
| | | | | | | | The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: add documents to development-processMauro Carvalho Chehab2016-10-2417-0/+6330
| | | | | | | | | | Add several documents to the development-process ReST book. As we don't want renames, use symlinks instead, keeping those documents on their original place. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs: rename development-process/ to process/Mauro Carvalho Chehab2016-10-2411-0/+2230
As we'll type this a lot, after adding CodingStyle & friends, let's rename the directory name to a shorter one. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
OpenPOWER on IntegriCloud