Commit bb6279d8 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

Merge branch 'submitting-drivers-removal' into docs-next 

Lukas Bulwahn says:

  Here is an attempt to delete submitting-drivers with some improvements
  and clean-up in other documentation places to convince ourselves that
  nothing valuable is lost when deleting this checklist.

  Patch 1, 2 and 3 is just basic clean-up before adding a new reference
  (see Patch 4). Patch 4 adds the one reference from submitting-drivers,
  not already mentioned elsewhere in the repository. Patch 5 updates a
  confusing statement in devices.rst from earlier .txt/.tex distinction
  times to the new state now with Sphinx & .rst.

  Patch 6 finally deletes the outdated document, with a cross-check what is
  covered elsewhere and few open questions (see below).

  Patch 7 and 8 have been reworked with the native-speaking doc
  maintainers; they cause no new warnings and are ready to pick,

  Patch 9 to 11 are weak attempts to adjust the translation, but they need
  to be taken further by others due to my lack of knowledge on the other
  languages.  They would currently also cause new warnings in the doc-build
  right now. They should not be picked if there is no one to continue to
  adjust the text and fix the warnings on broken references.

Additionally, this branch includes a translation fix from Alex Shi.
parents f8a291b7 0582591c

Documentation/admin-guide/devices.rst

+3 −4
Original line number Diff line number Diff line
@@ -7,10 +7,9 @@ This list is the Linux Device List, the official registry of allocated 
device numbers and ``/dev`` directory nodes for the Linux operating

system.



The LaTeX version of this document is no longer maintained, nor is

the document that used to reside at lanana.org.  This version in the

mainline Linux kernel is the master document.  Updates shall be sent

as patches to the kernel maintainers (see the

The version of this document at lanana.org is no longer maintained.  This

version in the mainline Linux kernel is the master document.  Updates

shall be sent as patches to the kernel maintainers (see the

:ref:`Documentation/process/submitting-patches.rst <submittingpatches>` document).

Specifically explore the sections titled "CHAR and MISC DRIVERS", and

"BLOCK LAYER" in the MAINTAINERS file to find the right maintainers

Documentation/hwmon/submitting-patches.rst

+0 −1
Original line number Diff line number Diff line
@@ -12,7 +12,6 @@ increase the chances of your change being accepted. 
* It should be unnecessary to mention, but please read and follow:



    - Documentation/process/submit-checklist.rst

    - Documentation/process/submitting-drivers.rst

    - Documentation/process/submitting-patches.rst

    - Documentation/process/coding-style.rst

Documentation/kernel-hacking/hacking.rst

+1 −2
Original line number Diff line number Diff line
@@ -755,8 +755,7 @@ make a neat patch, there's administrative work to be done: 
   it implies a more-than-passing commitment to some part of the code.



-  Finally, don't forget to read

   ``Documentation/process/submitting-patches.rst`` and possibly

   ``Documentation/process/submitting-drivers.rst``.

   ``Documentation/process/submitting-patches.rst``



Kernel Cantrips

===============

Documentation/process/5.Posting.rst

+1 −2
Original line number Diff line number Diff line
@@ -10,8 +10,7 @@ of conventions and procedures which are used in the posting of patches; 
following them will make life much easier for everybody involved.  This

document will attempt to cover these expectations in reasonable detail;

more information can also be found in the files

:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`,

:ref:`Documentation/process/submitting-drivers.rst  <submittingdrivers>`

:ref:`Documentation/process/submitting-patches.rst <submittingpatches>`

and :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`.

Documentation/process/8.Conclusion.rst

+7 −9
Original line number Diff line number Diff line
@@ -5,15 +5,13 @@ For more information 


There are numerous sources of information on Linux kernel development and

related topics.  First among those will always be the Documentation

directory found in the kernel source distribution.  The top-level :ref:`process/howto.rst <process_howto>`

file is an important starting point; :ref:`process/submitting-patches.rst <submittingpatches>`

and :ref:`process/submitting-drivers.rst  <submittingdrivers>`

are also something which all kernel developers should

read.  Many internal kernel APIs are documented using the kerneldoc

mechanism; "make htmldocs" or "make pdfdocs" can be used to generate those

documents in HTML or PDF format (though the version of TeX shipped by some

distributions runs into internal limits and fails to process the documents

properly).

directory found in the kernel source distribution.  Start with the

top-level :ref:`process/howto.rst <process_howto>`; also read

:ref:`process/submitting-patches.rst <submittingpatches>`. Many internal

kernel APIs are documented using the kerneldoc mechanism; "make htmldocs"

or "make pdfdocs" can be used to generate those documents in HTML or PDF

format (though the version of TeX shipped by some distributions runs into

internal limits and fails to process the documents properly).



Various web sites discuss kernel development at all levels of detail.  Your

author would like to humbly suggest https://lwn.net/ as a source;