mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-05-09 14:56:54 -04:00
bb6279d8ed
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.
Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.