Skip to content

Commit 9d85025

Browse files
committed
docs-rst: create an user's manual book
Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters on an user's manual book. As we'll be numbering the user's manual, remove the manual numbering from SecurityBugs. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
1 parent 186128f commit 9d85025

28 files changed

+53
-11
lines changed

README Documentation/admin-guide/README.rst

-1
Original file line numberDiff line numberDiff line change
@@ -408,4 +408,3 @@ If something goes wrong
408408

409409
gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
410410
disregards the starting offset for which the kernel is compiled.
411-

Documentation/bad_memory.txt Documentation/admin-guide/bad-memory.rst

-1
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,3 @@ With the numbers of the example above::
4848
or::
4949

5050
memmap=0x10000$0x18690000
51-

Documentation/basic_profiling.txt Documentation/admin-guide/basic-profiling.rst

-1
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,3 @@ Some ``opcontrol`` commands::
6666
To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file``
6767

6868
A reset is needed to clear old statistics, which survive a reboot.
69-
File renamed without changes.
File renamed without changes.

Documentation/admin-guide/conf.py

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# -*- coding: utf-8; mode: python -*-
2+
3+
project = 'Linux Kernel User Documentation'
4+
5+
tags.add("subproject")
6+
7+
latex_documents = [
8+
('index', 'linux-user.tex', 'Linux Kernel User Documentation',
9+
'The kernel development community', 'manual'),
10+
]

Documentation/devices.txt Documentation/admin-guide/devices.rst

-1
Original file line numberDiff line numberDiff line change
@@ -3348,4 +3348,3 @@ for the slaves; the slaves are named with decimal integers (``/dev/pts/#``
33483348
in our notation). This removes the problem of exhausting the
33493349
namespace and enables the kernel to automatically create the device
33503350
nodes for the slaves on demand using the "devpts" filesystem.
3351-

Documentation/admin-guide/index.rst

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Linux Kernel User's Documentation
2+
=================================
3+
4+
Contents:
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:numbered:
9+
10+
README
11+
reporting-bugs
12+
bug-hunting
13+
oops-tracing
14+
ramoops
15+
initrd
16+
init
17+
dynamic-debug-howto
18+
security-bugs
19+
kernel-parameters
20+
serial-console
21+
braille-console
22+
parport
23+
md
24+
module-signing
25+
sysrq
26+
unicode
27+
vga-softcursor
28+
sysfs-rules
29+
devices
30+
binfmt-misc
31+
mono
32+
java
33+
bad-memory
34+
basic-profiling
File renamed without changes.
File renamed without changes.

Documentation/java.txt Documentation/admin-guide/java.rst

-1
Original file line numberDiff line numberDiff line change
@@ -415,4 +415,3 @@ originally by Brian A. Lantz, brian@lantz.com
415415
heavily edited for binfmt_misc by Richard Günther
416416
new scripts by Colin J. Watson <cjw44@cam.ac.uk>
417417
added executable Jar file support by Kurt Huwig <kurt@iku-netz.de>
418-
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Documentation/SecurityBugs Documentation/admin-guide/security-bugs.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ like to know when a security bug is found so that it can be fixed and
88
disclosed as quickly as possible. Please report security bugs to the
99
Linux kernel security team.
1010

11-
1) Contact
12-
----------
11+
Contact
12+
-------
1313

1414
The Linux kernel security team can be contacted by email at
1515
<security@kernel.org>. This is a private list of security officers
@@ -23,8 +23,8 @@ REPORTING-BUGS if you are unclear about what information is helpful.
2323
Any exploit code is very helpful and will not be released without
2424
consent from the reporter unless it has already been made public.
2525

26-
2) Disclosure
27-
-------------
26+
Disclosure
27+
----------
2828

2929
The goal of the Linux kernel security team is to work with the
3030
bug submitter to bug resolution as well as disclosure. We prefer
@@ -39,8 +39,8 @@ disclosure is from immediate (esp. if it's already publicly known)
3939
to a few weeks. As a basic default policy, we expect report date to
4040
disclosure date to be on the order of 7 days.
4141

42-
3) Non-disclosure agreements
43-
----------------------------
42+
Non-disclosure agreements
43+
-------------------------
4444

4545
The Linux kernel security team is not a formal body and therefore unable
4646
to enter any non-disclosure agreements.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Documentation/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,8 @@
336336
# (source start file, target name, title,
337337
# author, documentclass [howto, manual, or own class]).
338338
latex_documents = [
339+
('user/index', 'linux-user.tex', 'Linux Kernel User Documentation',
340+
'The kernel development community', 'manual'),
339341
('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
340342
'The kernel development community', 'manual'),
341343
('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',

Documentation/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Contents:
1111
.. toctree::
1212
:maxdepth: 2
1313

14+
admin-guide/index
1415
kernel-documentation
1516
process/index
1617
dev-tools/tools

0 commit comments

Comments
 (0)