mirror of
				https://github.com/torvalds/linux.git
				synced 2025-11-04 02:30:34 +02:00 
			
		
		
		
	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>
This commit is contained in:
		
							parent
							
								
									186128f753
								
							
						
					
					
						commit
						9d85025b04
					
				
					 28 changed files with 53 additions and 11 deletions
				
			
		| 
						 | 
				
			
			@ -408,4 +408,3 @@ If something goes wrong
 | 
			
		|||
 | 
			
		||||
   gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
 | 
			
		||||
   disregards the starting offset for which the kernel is compiled.
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -48,4 +48,3 @@ With the numbers of the example above::
 | 
			
		|||
or::
 | 
			
		||||
 | 
			
		||||
	memmap=0x10000$0x18690000
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -66,4 +66,3 @@ Some ``opcontrol`` commands::
 | 
			
		|||
To only report on the kernel, run ``opreport -l /boot/vmlinux > output_file``
 | 
			
		||||
 | 
			
		||||
A reset is needed to clear old statistics, which survive a reboot.
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										10
									
								
								Documentation/admin-guide/conf.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								Documentation/admin-guide/conf.py
									
									
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,10 @@
 | 
			
		|||
# -*- coding: utf-8; mode: python -*-
 | 
			
		||||
 | 
			
		||||
project = 'Linux Kernel User Documentation'
 | 
			
		||||
 | 
			
		||||
tags.add("subproject")
 | 
			
		||||
 | 
			
		||||
latex_documents = [
 | 
			
		||||
    ('index', 'linux-user.tex', 'Linux Kernel User Documentation',
 | 
			
		||||
     'The kernel development community', 'manual'),
 | 
			
		||||
]
 | 
			
		||||
| 
						 | 
				
			
			@ -3348,4 +3348,3 @@ for the slaves; the slaves are named with decimal integers (``/dev/pts/#``
 | 
			
		|||
in our notation).  This removes the problem of exhausting the
 | 
			
		||||
namespace and enables the kernel to automatically create the device
 | 
			
		||||
nodes for the slaves on demand using the "devpts" filesystem.
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										34
									
								
								Documentation/admin-guide/index.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								Documentation/admin-guide/index.rst
									
									
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,34 @@
 | 
			
		|||
Linux Kernel User's Documentation
 | 
			
		||||
=================================
 | 
			
		||||
 | 
			
		||||
Contents:
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :maxdepth: 2
 | 
			
		||||
   :numbered:
 | 
			
		||||
 | 
			
		||||
   README
 | 
			
		||||
   reporting-bugs
 | 
			
		||||
   bug-hunting
 | 
			
		||||
   oops-tracing
 | 
			
		||||
   ramoops
 | 
			
		||||
   initrd
 | 
			
		||||
   init
 | 
			
		||||
   dynamic-debug-howto
 | 
			
		||||
   security-bugs
 | 
			
		||||
   kernel-parameters
 | 
			
		||||
   serial-console
 | 
			
		||||
   braille-console
 | 
			
		||||
   parport
 | 
			
		||||
   md
 | 
			
		||||
   module-signing
 | 
			
		||||
   sysrq
 | 
			
		||||
   unicode
 | 
			
		||||
   vga-softcursor
 | 
			
		||||
   sysfs-rules
 | 
			
		||||
   devices
 | 
			
		||||
   binfmt-misc
 | 
			
		||||
   mono
 | 
			
		||||
   java
 | 
			
		||||
   bad-memory
 | 
			
		||||
   basic-profiling
 | 
			
		||||
| 
						 | 
				
			
			@ -415,4 +415,3 @@ originally by Brian A. Lantz, brian@lantz.com
 | 
			
		|||
heavily edited for binfmt_misc by Richard Günther
 | 
			
		||||
new scripts by Colin J. Watson <cjw44@cam.ac.uk>
 | 
			
		||||
added executable Jar file support by Kurt Huwig <kurt@iku-netz.de>
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -8,8 +8,8 @@ like to know when a security bug is found so that it can be fixed and
 | 
			
		|||
disclosed as quickly as possible.  Please report security bugs to the
 | 
			
		||||
Linux kernel security team.
 | 
			
		||||
 | 
			
		||||
1) Contact
 | 
			
		||||
----------
 | 
			
		||||
Contact
 | 
			
		||||
-------
 | 
			
		||||
 | 
			
		||||
The Linux kernel security team can be contacted by email at
 | 
			
		||||
<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.
 | 
			
		|||
Any exploit code is very helpful and will not be released without
 | 
			
		||||
consent from the reporter unless it has already been made public.
 | 
			
		||||
 | 
			
		||||
2) Disclosure
 | 
			
		||||
-------------
 | 
			
		||||
Disclosure
 | 
			
		||||
----------
 | 
			
		||||
 | 
			
		||||
The goal of the Linux kernel security team is to work with the
 | 
			
		||||
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)
 | 
			
		|||
to a few weeks.  As a basic default policy, we expect report date to
 | 
			
		||||
disclosure date to be on the order of 7 days.
 | 
			
		||||
 | 
			
		||||
3) Non-disclosure agreements
 | 
			
		||||
----------------------------
 | 
			
		||||
Non-disclosure agreements
 | 
			
		||||
-------------------------
 | 
			
		||||
 | 
			
		||||
The Linux kernel security team is not a formal body and therefore unable
 | 
			
		||||
to enter any non-disclosure agreements.
 | 
			
		||||
| 
						 | 
				
			
			@ -336,6 +336,8 @@ latex_elements = {
 | 
			
		|||
# (source start file, target name, title,
 | 
			
		||||
#  author, documentclass [howto, manual, or own class]).
 | 
			
		||||
latex_documents = [
 | 
			
		||||
    ('user/index', 'linux-user.tex', 'Linux Kernel User Documentation',
 | 
			
		||||
     'The kernel development community', 'manual'),
 | 
			
		||||
    ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
 | 
			
		||||
     'The kernel development community', 'manual'),
 | 
			
		||||
    ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -11,6 +11,7 @@ Contents:
 | 
			
		|||
.. toctree::
 | 
			
		||||
   :maxdepth: 2
 | 
			
		||||
 | 
			
		||||
   admin-guide/index
 | 
			
		||||
   kernel-documentation
 | 
			
		||||
   process/index
 | 
			
		||||
   dev-tools/tools
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in a new issue