Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 73b4f63a authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-for-linus' of git://git.lwn.net/linux-2.6 

Pull documentation updates from Jonathan Corbet:
 "Highlights this time around include:

   - A thrashing of SubmittingPatches to bring it out of the "send
     everything to Linus" era of kernel development.

   - A new document on completions from Nicholas McGuire

   - Lots of typo fixes, formatting improvements, corrections, build
     fixes, and more"

* tag 'docs-for-linus' of git://git.lwn.net/linux-2.6: (35 commits)
  Documentation: Fix the wrong command `echo -1 > set_ftrace_pid` for cleaning the filter.
  can-doc: Fixed a wrong filepath in can.txt
  Documentation: Fix trivial typo in comment.
  kgdb,docs: Fix typo and minor style issues
  Documentation: add description for FTRACE probe status
  doc: brief user documentation for completion
  Documentation/misc-devices/mei: Fix indentation of embedded code.
  Documentation/misc-devices/mei: Fix indentation of enumeration.
  Documentation/misc-devices/mei: Fix spacing around parentheses.
  Documentation/misc-devices/mei: Fix formatting of headings.
  Documentation: devicetree: Fix double words in Doumentation/devicetree
  Documentation: mm: Fix typo in vm.txt
  lockstat: Add documentation on contention and contenting points
  Documentation: fix blackfin gptimers-example build errors
  Fixes column alignment in table of contents entry 1.9 in Documentation/filesystems/proc.txt
  CodingStyle: enable emacs display of trailing whitespace
  DocBook: Do not exceed argument list limit
  gpio: board.txt: Fix the gpio name example
  Documentation/SubmittingPatches: unify whitespace/tabs for the DCO
  MAINTAINERS: Add the docs-next git tree to the maintainer entry
  ...
parents bfe9183f 52e68924

Documentation/00-INDEX

+10 −18
Original line number Original line Diff line number Diff line
@@ -29,8 +29,6 @@ DMA-ISA-LPC.txt 
	- How to do DMA with ISA (and LPC) devices.

	- How to do DMA with ISA (and LPC) devices.

DMA-attributes.txt

DMA-attributes.txt

	- listing of the various possible attributes a DMA region can have

	- listing of the various possible attributes a DMA region can have

dmatest.txt

	- how to compile, configure and use the dmatest system.

DocBook/

DocBook/

	- directory with DocBook templates etc. for kernel documentation.

	- directory with DocBook templates etc. for kernel documentation.

EDID/

EDID/
@@ -163,8 +161,6 @@ digsig.txt 
	-info on the Digital Signature Verification API

	-info on the Digital Signature Verification API

dma-buf-sharing.txt

dma-buf-sharing.txt

	- the DMA Buffer Sharing API Guide

	- the DMA Buffer Sharing API Guide

dmaengine.txt

	-the DMA Engine API Guide

dontdiff

dontdiff

	- file containing a list of files that should never be diff'ed.

	- file containing a list of files that should never be diff'ed.

driver-model/

driver-model/
@@ -209,6 +205,8 @@ hid/ 
	- directory with information on human interface devices

	- directory with information on human interface devices

highuid.txt

highuid.txt

	- notes on the change from 16 bit to 32 bit user/group IDs.

	- notes on the change from 16 bit to 32 bit user/group IDs.

hsi.txt

	- HSI subsystem overview.

hwspinlock.txt

hwspinlock.txt

	- hardware spinlock provides hardware assistance for synchronization

	- hardware spinlock provides hardware assistance for synchronization

timers/

timers/
@@ -277,6 +275,8 @@ kprobes.txt 
	- documents the kernel probes debugging feature.

	- documents the kernel probes debugging feature.

kref.txt

kref.txt

	- docs on adding reference counters (krefs) to kernel objects.

	- docs on adding reference counters (krefs) to kernel objects.

kselftest.txt

	- small unittests for (some) individual codepaths in the kernel.

laptops/

laptops/

	- directory with laptop related info and laptop driver documentation.

	- directory with laptop related info and laptop driver documentation.

ldm.txt

ldm.txt
@@ -285,22 +285,22 @@ leds/ 
	- directory with info about LED handling under Linux.

	- directory with info about LED handling under Linux.

local_ops.txt

local_ops.txt

	- semantics and behavior of local atomic operations.

	- semantics and behavior of local atomic operations.

lockdep-design.txt

	- documentation on the runtime locking correctness validator.

locking/

locking/

	- directory with info about kernel locking primitives

	- directory with info about kernel locking primitives

lockstat.txt

	- info on collecting statistics on locks (and contention).

lockup-watchdogs.txt

lockup-watchdogs.txt

	- info on soft and hard lockup detectors (aka nmi_watchdog).

	- info on soft and hard lockup detectors (aka nmi_watchdog).

logo.gif

logo.gif

	- full colour GIF image of Linux logo (penguin - Tux).

	- full colour GIF image of Linux logo (penguin - Tux).

logo.txt

logo.txt

	- info on creator of above logo & site to get additional images from.

	- info on creator of above logo & site to get additional images from.

lzo.txt

	- kernel LZO decompressor input formats

m68k/

m68k/

	- directory with info about Linux on Motorola 68k architecture.

	- directory with info about Linux on Motorola 68k architecture.

magic-number.txt

magic-number.txt

	- list of magic numbers used to mark/protect kernel data structures.

	- list of magic numbers used to mark/protect kernel data structures.

mailbox.txt

	- How to write drivers for the common mailbox framework (IPC).

md.txt

md.txt

	- info on boot arguments for the multiple devices driver.

	- info on boot arguments for the multiple devices driver.

media-framework.txt

media-framework.txt
@@ -327,8 +327,6 @@ mtd/ 
	- directory with info about memory technology devices (flash)

	- directory with info about memory technology devices (flash)

mono.txt

mono.txt

	- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.

	- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.

mutex-design.txt

	- info on the generic mutex subsystem.

namespaces/

namespaces/

	- directory with various information about namespaces

	- directory with various information about namespaces

netlabel/

netlabel/
@@ -395,10 +393,6 @@ robust-futexes.txt 
	- a description of what robust futexes are.

	- a description of what robust futexes are.

rpmsg.txt

rpmsg.txt

	- info on the Remote Processor Messaging (rpmsg) Framework

	- info on the Remote Processor Messaging (rpmsg) Framework

rt-mutex-design.txt

	- description of the RealTime mutex implementation design.

rt-mutex.txt

	- desc. of RT-mutex subsystem with PI (Priority Inheritance) support.

rtc.txt

rtc.txt

	- notes on how to use the Real Time Clock (aka CMOS clock) driver.

	- notes on how to use the Real Time Clock (aka CMOS clock) driver.

s390/

s390/
@@ -425,8 +419,6 @@ sparse.txt 
	- info on how to obtain and use the sparse tool for typechecking.

	- info on how to obtain and use the sparse tool for typechecking.

spi/

spi/

	- overview of Linux kernel Serial Peripheral Interface (SPI) support.

	- overview of Linux kernel Serial Peripheral Interface (SPI) support.

spinlocks.txt

	- info on using spinlocks to provide exclusive access in kernel.

stable_api_nonsense.txt

stable_api_nonsense.txt

	- info on why the kernel does not have a stable in-kernel api or abi.

	- info on why the kernel does not have a stable in-kernel api or abi.

stable_kernel_rules.txt

stable_kernel_rules.txt
@@ -483,10 +475,10 @@ wimax/ 
	- directory with info about Intel Wireless Wimax Connections

	- directory with info about Intel Wireless Wimax Connections

workqueue.txt

workqueue.txt

	- information on the Concurrency Managed Workqueue implementation

	- information on the Concurrency Managed Workqueue implementation

ww-mutex-design.txt

	- Intro to Mutex wait/would deadlock handling.s

x86/x86_64/

x86/x86_64/

	- directory with info on Linux support for AMD x86-64 (Hammer) machines.

	- directory with info on Linux support for AMD x86-64 (Hammer) machines.

xillybus.txt

	- Overview and basic ui of xillybus driver

xtensa/

xtensa/

	- directory with documents relating to arch/xtensa port/implementation

	- directory with documents relating to arch/xtensa port/implementation

xz.txt

xz.txt

Documentation/Changes

+3 −3
Original line number Original line Diff line number Diff line
@@ -21,8 +21,8 @@ running a Linux kernel. Also, not all tools are necessary on all 
systems; obviously, if you don't have any ISDN hardware, for example,

systems; obviously, if you don't have any ISDN hardware, for example,

you probably needn't concern yourself with isdn4k-utils.

you probably needn't concern yourself with isdn4k-utils.





o  Gnu C                  3.2                     # gcc --version

o  GNU C                  3.2                     # gcc --version

o  Gnu make               3.80                    # make --version

o  GNU make               3.80                    # make --version

o  binutils               2.12                    # ld -v

o  binutils               2.12                    # ld -v

o  util-linux             2.10o                   # fdformat --version

o  util-linux             2.10o                   # fdformat --version

o  module-init-tools      0.9.10                  # depmod -V

o  module-init-tools      0.9.10                  # depmod -V
@@ -57,7 +57,7 @@ computer. 
Make

Make

----

----





You will need Gnu make 3.80 or later to build the kernel.

You will need GNU make 3.80 or later to build the kernel.





Binutils

Binutils

--------

--------

Documentation/CodingStyle

+1 −0
Original line number Original line Diff line number Diff line
@@ -527,6 +527,7 @@ values. To do the latter, you can stick the following in your .emacs file: 
                         (string-match (expand-file-name "~/src/linux-trees")

                         (string-match (expand-file-name "~/src/linux-trees")

                                       filename))

                                       filename))

                (setq indent-tabs-mode t)

                (setq indent-tabs-mode t)

                (setq show-trailing-whitespace t)

                (c-set-style "linux-tabs-only")))))

                (c-set-style "linux-tabs-only")))))





This will make emacs go better with the kernel coding style for C

This will make emacs go better with the kernel coding style for C

Documentation/DocBook/Makefile

+1 −1
Original line number Original line Diff line number Diff line
@@ -56,7 +56,7 @@ htmldocs: $(HTML) 




MAN := $(patsubst %.xml, %.9, $(BOOKS))

MAN := $(patsubst %.xml, %.9, $(BOOKS))

mandocs: $(MAN)

mandocs: $(MAN)

	$(if $(wildcard $(obj)/man/*.9),gzip -f $(obj)/man/*.9)

	find $(obj)/man -name '*.9' | xargs gzip -f





installmandocs: mandocs

installmandocs: mandocs

	mkdir -p /usr/local/man/man9/

	mkdir -p /usr/local/man/man9/

Documentation/DocBook/crypto-API.tmpl

+1 −1
Original line number Original line Diff line number Diff line
@@ -111,7 +111,7 @@ 
    <para>

    <para>

     This specification is intended for consumers of the kernel crypto

     This specification is intended for consumers of the kernel crypto

     API as well as for developers implementing ciphers. This API

     API as well as for developers implementing ciphers. This API

     specification, however, does not discusses all API calls available

     specification, however, does not discuss all API calls available

     to data transformation implementations (i.e. implementations of

     to data transformation implementations (i.e. implementations of

     ciphers and other transformations (such as CRC or even compression

     ciphers and other transformations (such as CRC or even compression

     algorithms) that can register with the kernel crypto API).

     algorithms) that can register with the kernel crypto API).