Linux kernel source tree
Find a file
Mauro Carvalho Chehab 290d538899 scripts: documentation-file-ref-check: improve :doc: handling
There are some issues at the script with regards to :doc:
tags:

- It doesn't escape files under Documentation/sphinx,
  leading to false positives;
- It doesn't handle root URLs, like :doc:`/x86/boot`;
- It doesn't output the file with a bad reference.

Address those things, in order to remove false positives
from the list of problems.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-02-25 03:01:05 -07:00
arch
block
certs
crypto
Documentation docs/core-api: Add Fedora instructions for GCC plugins 2020-02-25 02:44:35 -07:00
drivers
fs
include
init
ipc
kernel
lib
LICENSES
mm
net
samples
scripts scripts: documentation-file-ref-check: improve :doc: handling 2020-02-25 03:01:05 -07:00
security
sound
tools tools/edid: Move EDID data sets from Documentation/ 2020-02-19 04:10:32 -07:00
usr
virt
.clang-format
.cocciconfig
.get_maintainer.ignore
.gitattributes
.gitignore
.mailmap
COPYING
CREDITS
Kbuild
Kconfig
MAINTAINERS
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.