mirrors/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-03-18 13:32:42 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
2cbeb64f6c709de67e2ba5b97ff45d2b6147b286
linux/Documentation
History
Mauro Carvalho Chehab c16f291dee sync_file.txt: standardize document format 
Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- Use markup for document title and authorship;
- Mark literal blocks;
- Use a numbered list for references.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.com>
Link: http://patchwork.freedesktop.org/patch/msgid/e781f61e582e7c7eb5de456608043aff9fe2b2b5.1495157082.git.mchehab@s-opensource.com
2017-05-24 13:01:27 -03:00
..
ABI
Merge tag 'pci-v4.12-changes' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaas/pci
2017-05-08 19:03:25 -07:00
accounting
tools: move accounting tool from Documentation
2016-09-23 13:07:15 -06:00
acpi
Merge tag 'docs-4.12' of git://git.lwn.net/linux
2017-05-02 10:21:17 -07:00
admin-guide
Merge tag 'docs-4.12-2' of git://git.lwn.net/linux
2017-05-11 11:29:52 -07:00
aoe
…
arm
Merge tag 'armsoc-soc' of git://git.kernel.org/pub/scm/linux/kernel/git/arm/arm-soc
2017-05-09 09:49:36 -07:00
arm64
arm64: documentation: document tagged pointer stack constraints
2017-05-09 17:43:18 +01:00
auxdisplay
samples: move auxdisplay example code from Documentation
2016-09-23 11:52:32 -06:00
backlight
…
blackfin
samples: move blackfin gptimers-example from Documentation
2016-10-10 07:12:02 -06:00
block
block, bfq: stress that low_latency must be off to get max throughput
2017-05-10 07:39:43 -06:00
blockdev
remove the mg_disk driver
2017-04-14 14:00:49 -06:00
bus-devices
…
cdrom
cdrom: Make device operations read-only
2017-02-14 08:29:56 -07:00
cgroup-v1
Merge branch 'for-4.11' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup
2017-02-27 21:41:08 -08:00
cma
…
connector
samples: connector: from Documentation to samples directory
2016-04-28 07:47:35 -06:00
console
…
core-api
docs-rst: core_api: move driver-specific stuff to drivers_api
2017-04-02 14:17:43 -06:00
cpu-freq
cpufreq: User/admin documentation update and consolidation
2017-03-13 17:08:42 -06:00
cpuidle
…
cris
…
crypto
Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris/linux-security
2017-05-03 08:50:52 -07:00
dev-tools
scripts/spelling.txt: add "disble(d)" pattern and fix typo instances
2017-03-09 17:01:09 -08:00
device-mapper
Merge tag 'for-4.12/dm-changes' of git://git.kernel.org/pub/scm/linux/kernel/git/device-mapper/linux-dm
2017-05-03 10:31:20 -07:00
devicetree
Merge tag 'drm-misc-next-2017-05-16' of git://anongit.freedesktop.org/git/drm-misc into drm-next
2017-05-18 12:57:06 +10:00
dmaengine
dmaengine: Documentation: Fix typo in pxa_dma.txt
2016-11-14 08:14:24 +05:30
doc-guide
docs-rst: automatically convert Graphviz and SVG images
2017-03-09 02:59:26 -07:00
DocBook
Merge tag 'char-misc-4.12-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/char-misc
2017-05-04 19:15:35 -07:00
driver-api
Merge tag 'char-misc-4.12-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/char-misc
2017-05-04 19:15:35 -07:00
driver-model
PCI: Implement devm_pci_remap_cfgspace()
2017-04-24 13:53:13 -05:00
early-userspace
Documentation: Fix dead URLs to ftp.kernel.org
2017-03-29 15:46:06 -06:00
EDID
drm: use .hword to represent 16-bit numbers
2017-03-30 10:15:19 +02:00
extcon
extcon: Remove porting compatibility of swich class
2017-04-06 10:55:24 +09:00
fault-injection
net: Add support for CHANGEUPPER notifier error injection
2015-12-03 11:49:23 -05:00
fb
Documentation: fb: fix spelling mistakes
2016-05-10 12:05:27 +03:00
features
Merge tag 'powerpc-4.12-1' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc/linux
2017-05-05 11:36:44 -07:00
filesystems
Tigran has moved
2017-05-12 15:57:15 -07:00
firmware_class
firmware: revamp firmware documentation
2017-01-11 09:42:59 +01:00
fmc
…
fpga
fpga: Add scatterlist based programming
2017-02-10 15:20:44 +01:00
frv
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
gpio
gpio: return NULL from gpiod_get_optional when GPIOLIB is disabled
2017-03-15 11:16:30 +01:00
gpu
Merge tag 'drm-misc-next-2017-05-16' of git://anongit.freedesktop.org/git/drm-misc into drm-next
2017-05-18 12:57:06 +10:00
hid
Documentation: hid: fix path to input bus definitions
2017-03-13 17:15:19 -06:00
hwmon
drivers: hwmon: Support for ASPEED PWM/Fan tach
2017-04-10 13:12:18 -07:00
i2c
i2c: i801: Add support for Intel Gemini Lake
2017-02-09 17:39:16 +01:00
ia64
selftests: move ia64 tests from Documentation/ia64
2016-09-20 09:58:12 -06:00
ide
…
iio
iio: Documentation: Correct the path used to create triggers.
2016-10-01 00:49:58 -06:00
infiniband
IB/opa-vnic: Virtual Network Interface Controller (VNIC) documentation
2017-04-20 12:01:06 -04:00
input
docs-rst: add input docs at main index and use kernel-figure
2017-05-09 13:36:02 -06:00
ioctl
Merge tag 'armsoc-tee' of git://git.kernel.org/pub/scm/linux/kernel/git/arm/arm-soc
2017-05-10 11:20:09 -07:00
isdn
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
kbuild
uapi: export all arch specifics directories
2017-05-11 00:22:17 +09:00
kdump
Documentation: kdump: describe arm64 port
2017-04-05 18:32:32 +01:00
laptops
platform/x86: thinkpad_acpi: Add support for X1 Yoga (2016) Tablet Mode
2016-12-13 09:29:06 -08:00
leds
Documentaion: leds: leds-lp55xx.txt: Fix typos
2017-03-17 13:06:14 -06:00
lightnvm
lightnvm: physical block device (pblk) target
2017-04-16 10:06:33 -06:00
livepatch
livepatch: allow removal of a disabled patch
2017-03-08 09:38:43 +01:00
locking
locking/ww_mutex/Documentation: Update the design document
2017-01-14 11:14:55 +01:00
m68k
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
md
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/shli/md
2017-05-03 10:05:38 -07:00
media
Merge tag 'media/v4.12-1' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media
2017-05-05 17:34:57 -07:00
memory-devices
…
metag
…
mic
samples: move mic/mpssd example code from Documentation
2016-09-20 12:38:48 -06:00
mips
…
misc-devices
Documentation: misc-devices: Add Documentation for pci-endpoint-test driver
2017-04-28 10:23:19 -05:00
mmc
Merge tag 'mmc-v4.12' of git://git.kernel.org/pub/scm/linux/kernel/git/ulfh/mmc
2017-05-02 17:34:32 -07:00
mn10300
…
mtd
spi-nor: Add support for Intel SPI serial flash controller
2017-01-03 17:33:36 +00:00
namespaces
…
netlabel
…
networking
Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next
2017-05-02 16:40:27 -07:00
nfc
…
nios2
…
nvdimm
libnvdimm, btt: update the usage section in Documentation
2016-06-17 16:23:23 -07:00
nvmem
Documentation: nvmem: add nvmem api level and how-to doc
2015-08-05 13:43:45 -07:00
parisc
…
PCI
Merge tag 'pci-v4.12-changes' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaas/pci
2017-05-08 19:03:25 -07:00
pcmcia
tools: move pcmcia crc32hash tool from Documentation
2016-09-23 13:07:27 -06:00
perf
perf: qcom: Add L3 cache PMU driver
2017-04-03 18:53:50 +01:00
phy
…
platform
…
power
Merge tag 'docs-4.12' of git://git.lwn.net/linux
2017-05-02 10:21:17 -07:00
powerpc
powerpc/fadump: update documentation about crashkernel parameter reuse
2017-05-08 17:15:11 -07:00
pps
Doc: clarify source of jitter in USB1.1, and USB2.0
2017-01-04 14:40:52 -07:00
prctl
selftests: move prctl tests from Documentation/prctl
2016-09-20 09:09:09 -06:00
process
docs: complete bumping minimal GNU Make version to 3.81
2017-05-06 18:49:09 -07:00
pti
…
ptp
selftests: move ptp tests from Documentation/ptp
2016-09-20 09:54:38 -06:00
rapidio
rapidio/documentation/mport_cdev: add missing parameter description
2016-09-01 17:52:02 -07:00
RCU
Merge branches 'doc.2017.04.12a', 'fixes.2017.04.19a' and 'srcu.2017.04.21a' into HEAD
2017-04-21 06:00:13 -07:00
s390
docs: add documentation for vfio-ccw
2017-03-31 12:55:11 +02:00
scheduler
sched/Documentation: Add 'sched-pelt' tool
2017-04-14 10:26:35 +02:00
scsi
scsi: make asynchronous aborts mandatory
2017-04-06 13:07:33 -04:00
security
KEYS: add SP800-56A KDF support for DH
2017-04-04 22:33:38 +01:00
serial
Documentation: rs485: Do not define manually the ioctl
2016-08-18 11:08:33 -06:00
sh
…
sound
ALSA: hda - Allow to enable/disable vmaster build explicitly
2017-04-10 17:45:27 +02:00
sparc
Documentation/sparc: Steps for sending break on sunhv console
2017-02-23 08:27:25 -08:00
sphinx
tmplcvt: make the tool more robust
2017-04-11 14:35:15 -06:00
sphinx-static
Merge tag 'docs-4.9' of git://git.lwn.net/linux
2016-10-04 13:54:07 -07:00
spi
spi: spi-ep93xx: simplify GPIO chip selects
2017-02-16 20:10:26 +00:00
sysctl
Replace 2 jiffies with sysctl netdev_budget_usecs to enable softirq tuning
2017-04-21 13:22:34 -04:00
target
Documentation/target: add an example script to configure an iSCSI target
2017-05-01 22:21:35 -07:00
thermal
Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/rzhang/linux
2017-05-12 11:58:45 -07:00
timers
time: Remove CONFIG_TIMER_STATS
2017-02-10 11:15:08 +01:00
trace
Merge tag 'trace-v4.12' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace
2017-05-03 18:41:21 -07:00
translations
docs: update references to the device io book
2017-05-09 13:44:56 -06:00
usb
Merge tag 'usb-4.12-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb
2017-05-04 18:03:51 -07:00
userspace-api
docs: Convert unshare.txt to RST and add to the user-space API manual
2017-04-02 15:18:32 -06:00
virtual
Merge tag 'kvm-arm-for-v4.12-round2' of git://git.kernel.org/pub/scm/linux/kernel/git/kvmarm/kvmarm into HEAD
2017-05-09 12:51:49 +02:00
vm
Documentation/vm/transhuge.txt: fix trivial typos
2017-05-08 17:15:14 -07:00
w1
w1: add documentation for w1_ds2438
2017-03-17 15:10:49 +09:00
watchdog
watchdog: Introduce watchdog_stop_on_unregister helper
2017-02-24 14:00:23 -08:00
wimax
…
x86
x86/intel_rdt: Fix a typo in Documentation
2017-05-09 09:41:42 +02:00
xtensa
xtensa: cleanup MMU setup and kernel layout macros
2016-07-24 06:33:58 +03:00
.gitignore
Add .pyc files to .gitignore
2016-06-30 13:07:33 -06:00
00-INDEX
Documentation: tee subsystem and op-tee driver
2017-03-10 14:51:57 +01:00
bcache.txt
bcache: documentation formatting, edited for clarity, stripe alignment notes
2016-06-23 07:58:38 -06:00
bt8xxgpio.txt
…
btmrvl.txt
…
bus-virt-phys-mapping.txt
…
cachetlb.txt
…
cgroup-v2.txt
mm, docs: update memory.stat description with workingset* entries
2017-05-12 15:57:16 -07:00
Changes
docs: add back 'Documentation/Changes' file (as symlink)
2016-12-14 16:30:12 -08:00
circular-buffers.txt
Documentation: circular-buffers: use READ_ONCE()
2016-11-16 16:17:45 -07:00
clk.txt
Documentation: clk: update file names containing referenced structures
2016-08-14 12:12:36 -06:00
CodingStyle
doc: re-add CodingStyle and SubmittingPatches
2016-10-24 08:12:35 -02:00
conf.py
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
2017-05-03 12:38:20 -07:00
cpu-load.txt
…
cputopology.txt
docs: Fix a couple typos
2017-04-27 15:54:39 -06:00
crc32.txt
…
dcdbas.txt
…
debugging-modules.txt
…
debugging-via-ohci1394.txt
docs: Fix a couple typos
2017-04-27 15:54:39 -06:00
dell_rbu.txt
…
digsig.txt
…
DMA-API-HOWTO.txt
Documentation: DMA-API-HOWTO: Fix a typo
2016-09-20 17:58:46 -06:00
DMA-API.txt
dma-mapping: add dma_{map,unmap}_resource
2016-09-26 22:16:41 +05:30
DMA-attributes.txt
common: DMA-mapping: add DMA_ATTR_PRIVILEGED attribute
2017-01-19 15:56:19 +00:00
DMA-ISA-LPC.txt
Documentation: DMA-ISA-LPC.txt
2017-02-12 15:20:07 -07:00
docutils.conf
doc-rst: add docutils config file
2016-08-14 11:52:40 -06:00
dontdiff
Documentation: dontdiff: Update with additional entries
2017-01-26 15:08:06 -07:00
efi-stub.txt
doc: efi-stub.txt: Fix arm64 paths
2015-12-14 15:24:03 +00:00
eisa.txt
…
flexible-arrays.txt
…
futex-requeue-pi.txt
…
gcc-plugins.txt
gcc-plugins: update architecture list in documentation
2017-03-21 22:20:05 +11:00
highuid.txt
…
hw_random.txt
hwrng: doc - Fix device node name reference /dev/hw_random => /dev/hwrng
2015-09-21 22:00:41 +08:00
hwspinlock.txt
…
index.rst
docs-rst: add input docs at main index and use kernel-figure
2017-05-09 13:36:02 -06:00
intel_txt.txt
…
Intel-IOMMU.txt
iommu/vt-d: Fix link to Intel IOMMU Specification
2016-01-29 12:32:12 +01:00
io_ordering.txt
…
io-mapping.txt
…
iostats.txt
…
IPMI.txt
Documentation: Fix a typo in IPMI.txt.
2017-01-05 15:01:54 -06:00
IRQ-affinity.txt
…
IRQ-domain.txt
Documentation/IRQ-domain.txt: Document irq_domain_create_{linear, tree}
2016-03-31 00:32:59 -06:00
IRQ.txt
…
irqflags-tracing.txt
…
isa.txt
Documentation: Add ISA bus driver documentation
2016-05-02 09:32:04 -07:00
isapnp.txt
…
kernel-doc-nano-HOWTO.txt
docs-rst: doc-guide: split the kernel-documentation.rst contents
2016-11-19 10:22:04 -07:00
kernel-per-CPU-kthreads.txt
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
kobject.txt
…
kprobes.txt
Documentation: kprobes: Document jprobes stack copying limitations
2016-08-15 10:19:11 -06:00
kref.txt
Revert "kref: double kref_put() in my_data_handler()"
2017-04-08 18:38:10 +02:00
kselftest.txt
scripts/spelling.txt: add "an user" pattern and fix typo instances
2017-02-27 18:43:46 -08:00
ldm.txt
…
lockup-watchdogs.txt
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
logo.gif
…
logo.txt
…
lzo.txt
Documentation: lzo: fix spelling mistakes
2016-04-28 07:23:11 -06:00
mailbox.txt
Documentation: minor typo fix in mailbox.txt
2015-08-13 18:03:18 -06:00
Makefile
samples: move blackfin gptimers-example from Documentation
2016-10-10 07:12:02 -06:00
Makefile.sphinx
Add a target to check broken external links in the Documentation
2017-02-15 15:22:47 -07:00
memory-barriers.txt
Merge tag 'docs-4.12-2' of git://git.lwn.net/linux
2017-05-11 11:29:52 -07:00
memory-hotplug.txt
scripts/spelling.txt: add "followings" pattern and fix typo instances
2017-02-27 18:43:47 -08:00
men-chameleon-bus.txt
Documentation: Minor changes to men-chameleon-bus.txt
2015-07-24 15:15:17 +02:00
nommu-mmap.txt
…
ntb.txt
NTB: Rename Intel code names to platform names
2015-07-04 14:09:25 -04:00
numastat.txt
…
padata.txt
…
parport-lowlevel.txt
…
percpu-rw-semaphore.txt
…
phy.txt
Documentation: phy: Fix repetition of word 'the'
2017-03-09 00:33:15 -07:00
pi-futex.txt
…
pinctrl.txt
pinctrl: core: Fix pinctrl_register_and_init() with pinctrl_enable()
2017-04-07 01:08:08 +02:00
pnp.txt
…
preempt-locking.txt
…
printk-formats.txt
mm, printk: introduce new format string for flags
2016-03-15 16:55:16 -07:00
pwm.txt
pwm: Update documentation
2016-05-17 14:48:04 +02:00
rbtree.txt
documentation: fix small typo in rbtree.txt
2015-09-13 14:38:50 -06:00
remoteproc.txt
remoteproc: Split driver and consumer dereferencing
2016-10-02 22:50:21 -07:00
rfkill.txt
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
robust-futex-ABI.txt
…
robust-futexes.txt
Documentation: robust-futexes: fix spelling mistakes
2016-04-28 07:26:41 -06:00
rpmsg.txt
rpmsg: use module_rpmsg_driver in existing drivers and examples
2016-05-06 11:09:01 -07:00
rtc.txt
rtc: implement a sysfs interface for clock offset
2016-03-14 17:08:16 +01:00
SAK.txt
…
sgi-ioc4.txt
…
siphash.txt
siphash: implement HalfSipHash1-3 for hash tables
2017-01-09 13:58:57 -05:00
SM501.txt
…
smsc_ece1099.txt
…
static-keys.txt
docs: Fix a couple typos
2017-04-27 15:54:39 -06:00
SubmittingPatches
doc: re-add CodingStyle and SubmittingPatches
2016-10-24 08:12:35 -02:00
svga.txt
…
switchtec.txt
switchtec: Add IOCTLs to the Switchtec driver
2017-04-12 12:23:37 -05:00
sync_file.txt
sync_file.txt: standardize document format
2017-05-24 13:01:27 -03:00
tee.txt
Documentation: tee subsystem and op-tee driver
2017-03-10 14:51:57 +01:00
this_cpu_ops.txt
…
unaligned-memory-access.txt
Documentation/unaligned-memory-access.txt: fix incorrect comparison operator
2016-12-27 13:08:42 -07:00
vfio-mediated-device.txt
docs: Fix a spelling error in vfio-mediated-device.txt
2017-04-27 15:54:39 -06:00
vfio.txt
…
video-output.txt
…
xillybus.txt
Documentation: xillybus: fix spelling mistake
2016-04-28 07:44:54 -06:00
xz.txt
…
zorro.txt
docs: Fix a couple typos
2017-04-27 15:54:39 -06:00