Main-line Linux kernel tree http://www.kernel.org
Go to file
Jonathan Corbet d47a97bd38 docs: move superh documentation under Documentation/arch/
Architecture-specific documentation is being moved into Documentation/arch/
as a way of cleaning up the top-level documentation directory and making
the docs hierarchy more closely match the source hierarchy.  Move
Documentation/sh into arch/ and fix all in-tree references.

Cc: Yoshinori Sato <ysato@users.sourceforge.jp>
Cc: Rich Felker <dalias@libc.org>
Cc: John Paul Adrian Glaubitz <glaubitz@physik.fu-berlin.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-03-30 13:00:35 -06:00
arch docs: move superh documentation under Documentation/arch/ 2023-03-30 13:00:35 -06:00
block
certs
crypto
Documentation docs: move superh documentation under Documentation/arch/ 2023-03-30 13:00:35 -06:00
drivers docs: move sparc documentation under Documentation/arch/ 2023-03-30 13:00:34 -06:00
fs
include
init
io_uring
ipc
kernel
lib
LICENSES
mm
net
rust
samples
scripts
security docs: move x86 documentation into Documentation/arch/ 2023-03-30 12:58:51 -06:00
sound
tools docs: move x86 documentation into Documentation/arch/ 2023-03-30 12:58:51 -06:00
usr
virt
.clang-format
.cocciconfig
.get_maintainer.ignore
.gitattributes
.gitignore
.mailmap
.rustfmt.toml
COPYING
CREDITS
Kbuild
Kconfig
MAINTAINERS docs: move superh documentation under Documentation/arch/ 2023-03-30 13:00:35 -06:00
Makefile
README

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.