Merge tag 'docs-4.13' of git://git.lwn.net/linux

650fc870 · Linus Torvalds <[email protected]> · 2017-07-03 21:13:25 -07:00

Pull documentation updates from Jonathan Corbet:
 "There has been a fair amount of activity in the docs tree this time
  around. Highlights include:

   - Conversion of a bunch of security documentation into RST

   - The conversion of the remaining DocBook templates by The Amazing
     Mauro Machine. We can now drop the entire DocBook build chain.

   - The usual collection of fixes and minor updates"

* tag 'docs-4.13' of git://git.lwn.net/linux: (90 commits)
  scripts/kernel-doc: handle DECLARE_HASHTABLE
  Documentation: atomic_ops.txt is core-api/atomic_ops.rst
  Docs: clean up some DocBook loose ends
  Make the main documentation title less Geocities
  Docs: Use kernel-figure in vidioc-g-selection.rst
  Docs: fix table problems in ras.rst
  Docs: Fix breakage with Sphinx 1.5 and upper
  Docs: Include the Latex "ifthen" package
  doc/kokr/howto: Only send regression fixes after -rc1
  docs-rst: fix broken links to dynamic-debug-howto in kernel-parameters
  doc: Document suitability of IBM Verse for kernel development
  Doc: fix a markup error in coding-style.rst
  docs: driver-api: i2c: remove some outdated information
  Documentation: DMA API: fix a typo in a function name
  Docs: Insert missing space to separate link from text
  doc/ko_KR/memory-barriers: Update control-dependencies example
  Documentation, kbuild: fix typo "minimun" -> "minimum"
  docs: Fix some formatting issues in request-key.rst
  doc: ReSTify keys-trusted-encrypted.txt
  doc: ReSTify keys-request-key.txt
  ...

Commit: 650fc870a2ef35b83397eebd35b8c8df211bff78
Parents: f4dd029e · 1cb566ba

Merge commit. Changes below are compared with the first parent: f4dd029e.

Changes

180 files changed · +8397 −12189

File	Status	Add	Del	Content
Documentation/00-INDEX	modified	+2	−4	View file
Documentation/DMA-API.txt	modified	+1	−1	View file
Documentation/DocBook/.gitignore	deleted	+0	−17	View before deletion
Documentation/DocBook/Makefile	deleted	+0	−282	View before deletion
Documentation/DocBook/filesystems.tmpl	deleted	+0	−381	View before deletion
Documentation/DocBook/kernel-hacking.tmpl	deleted	+0	−1312	View before deletion
Documentation/DocBook/kernel-locking.tmpl	deleted	+0	−2151	View before deletion
Documentation/DocBook/kgdb.tmpl	deleted	+0	−918	View before deletion
Documentation/DocBook/libata.tmpl	deleted	+0	−1625	View before deletion
Documentation/DocBook/librs.tmpl	deleted	+0	−289	View before deletion
Documentation/DocBook/lsm.tmpl	deleted	+0	−265	View before deletion
Documentation/DocBook/mtdnand.tmpl	deleted	+0	−1291	View before deletion
Documentation/DocBook/networking.tmpl	deleted	+0	−111	View before deletion
Documentation/DocBook/rapidio.tmpl	deleted	+0	−155	View before deletion
Documentation/DocBook/s390-drivers.tmpl	deleted	+0	−161	View before deletion
Documentation/DocBook/scsi.tmpl	deleted	+0	−409	View before deletion
Documentation/DocBook/sh.tmpl	deleted	+0	−105	View before deletion
Documentation/DocBook/stylesheet.xsl	deleted	+0	−11	View before deletion
Documentation/DocBook/w1.tmpl	deleted	+0	−101	View before deletion
Documentation/DocBook/z8530book.tmpl	deleted	+0	−371	View before deletion
Documentation/Makefile	modified	+125	−0	View file
Documentation/Makefile.sphinx	deleted	+0	−130	View before deletion
Documentation/PCI/MSI-HOWTO.txt	modified	+1	−1	View file
Documentation/security/LoadPin.txt → Documentation/admin-guide/LSM/LoadPin.rst	renamed	+8	−4	View file
Documentation/security/SELinux.txt → Documentation/admin-guide/LSM/SELinux.rst	renamed	+12	−6	View file
Documentation/security/Smack.txt → Documentation/admin-guide/LSM/Smack.rst	renamed	+189	−84	View file
Documentation/security/Yama.txt → Documentation/admin-guide/LSM/Yama.rst	renamed	+29	−26	View file
Documentation/security/apparmor.txt → Documentation/admin-guide/LSM/apparmor.rst	renamed	+24	−12	View file
Documentation/security/LSM.txt → Documentation/admin-guide/LSM/index.rst	renamed	+14	−14	View file
Documentation/security/tomoyo.txt → Documentation/admin-guide/LSM/tomoyo.rst	renamed	+16	−6	View file
Documentation/admin-guide/README.rst	modified	+0	−6	View file
Documentation/admin-guide/index.rst	modified	+1	−0	View file
Documentation/admin-guide/kernel-parameters.txt	modified	+4	−2	View file
Documentation/admin-guide/ras.rst	modified	+5	−5	View file
Documentation/conf.py	modified	+35	−9	View file
Documentation/core-api/assoc_array.rst	modified	+4	−1	View file
Documentation/core-api/index.rst	modified	+1	−0	View file
Documentation/core-api/librs.rst	added	+212	−0	View file
Documentation/crypto/asymmetric-keys.txt	modified	+1	−1	View file
Documentation/security/conf.py → Documentation/crypto/conf.py	renamed	+4	−2	View file
Documentation/dev-tools/index.rst	modified	+1	−0	View file
Documentation/dev-tools/kgdb.rst	added	+907	−0	View file
Documentation/doc-guide/docbook.rst	deleted	+0	−90	View before deletion
Documentation/doc-guide/index.rst	modified	+0	−1	View file
Documentation/doc-guide/kernel-doc.rst	modified	+10	−0	View file
Documentation/doc-guide/sphinx.rst	modified	+0	−5	View file
Documentation/dontdiff	modified	+0	−1	View file
Documentation/driver-api/i2c.rst	modified	+4	−5	View file
Documentation/driver-api/index.rst	modified	+6	−0	View file
Documentation/driver-api/libata.rst	added	+1031	−0	View file
Documentation/driver-api/mtdnand.rst	added	+1007	−0	View file
Documentation/driver-api/rapidio.rst	added	+107	−0	View file
Documentation/driver-api/s390-drivers.rst	added	+111	−0	View file
Documentation/driver-api/scsi.rst	added	+344	−0	View file
Documentation/driver-api/w1.rst	added	+70	−0	View file
Documentation/fb/api.txt	modified	+2	−2	View file
Documentation/filesystems/conf.py	added	+10	−0	View file
Documentation/filesystems/index.rst	added	+317	−0	View file
Documentation/filesystems/nfs/idmapper.txt	modified	+1	−1	View file
Documentation/gpu/todo.rst	modified	+1	−1	View file
Documentation/index.rst	modified	+16	−2	View file
Documentation/kbuild/makefiles.txt	modified	+1	−1	View file
Documentation/kernel-doc-nano-HOWTO.txt	modified	+11	−54	View file
Documentation/kernel-hacking/conf.py	added	+10	−0	View file
Documentation/kernel-hacking/hacking.rst	added	+811	−0	View file
Documentation/kernel-hacking/index.rst	added	+9	−0	View file
Documentation/kernel-hacking/locking.rst	added	+1446	−0	View file
Documentation/lsm.txt	added	+201	−0	View file
Documentation/media/uapi/v4l/vidioc-g-selection.rst	modified	+2	−2	View file
Documentation/memory-barriers.txt	modified	+5	−5	View file
Documentation/networking/conf.py	added	+10	−0	View file
Documentation/networking/dns_resolver.txt	modified	+1	−1	View file
Documentation/networking/index.rst	added	+18	−0	View file
Documentation/networking/kapi.rst	added	+147	−0	View file
Documentation/networking/z8530book.rst	added	+256	−0	View file
Documentation/process/changes.rst	modified	+5	−21	View file
Documentation/process/coding-style.rst	modified	+2	−2	View file
Documentation/process/email-clients.rst	modified	+5	−0	View file
Documentation/process/howto.rst	modified	+0	−8	View file
Documentation/process/kernel-docs.rst	modified	+1	−33	View file
Documentation/security/00-INDEX	deleted	+0	−26	View before deletion
Documentation/security/IMA-templates.txt → Documentation/security/IMA-templates.rst	renamed	+26	−20	View file
Documentation/security/LSM.rst	added	+14	−0	View file
Documentation/security/credentials.txt → Documentation/security/credentials.rst	renamed	+124	−151	View file
Documentation/security/index.rst	modified	+7	−1	View file
Documentation/security/keys.txt → Documentation/security/keys/core.rst	renamed	+151	−163	View file
Documentation/security/keys-ecryptfs.txt → Documentation/security/keys/ecryptfs.rst	renamed	+12	−7	View file
Documentation/security/keys/index.rst	added	+11	−0	View file
Documentation/security/keys-request-key.txt → Documentation/security/keys/request-key.rst	renamed	+35	−38	View file
Documentation/security/keys-trusted-encrypted.txt → Documentation/security/keys/trusted-encrypted.rst	renamed	+20	−12	View file
Documentation/security/self-protection.txt → Documentation/security/self-protection.rst	renamed	+63	−36	View file
Documentation/sh/conf.py	added	+10	−0	View file
Documentation/sh/index.rst	added	+59	−0	View file
Documentation/sound/conf.py	added	+10	−0	View file
Documentation/sphinx/convert_template.sed	deleted	+0	−18	View before deletion
Documentation/sphinx/post_convert.sed	deleted	+0	−23	View before deletion
Documentation/sphinx/tmplcvt	deleted	+0	−28	View before deletion
Documentation/translations/ja_JP/howto.rst	modified	+0	−7	View file
Documentation/translations/ko_KR/howto.rst	modified	+11	−16	View file
Documentation/translations/ko_KR/memory-barriers.txt	modified	+1	−1	View file
Documentation/userspace-api/index.rst	modified	+2	−0	View file
Documentation/prctl/no_new_privs.txt → Documentation/userspace-api/no_new_privs.rst	renamed	+25	−19	View file
Documentation/prctl/seccomp_filter.txt → Documentation/userspace-api/seccomp_filter.rst	renamed	+60	−56	View file
Documentation/userspace-api/unshare.rst	modified	+1	−1	View file
MAINTAINERS	modified	+12	−9	View file
Makefile	modified	+3	−7	View file
arch/ia64/include/asm/io.h	modified	+1	−1	View file
arch/ia64/sn/kernel/iomv.c	modified	+1	−1	View file
drivers/ata/acard-ahci.c	modified	+1	−1	View file
drivers/ata/ahci.c	modified	+1	−1	View file
drivers/ata/ahci.h	modified	+1	−1	View file
drivers/ata/ata_piix.c	modified	+1	−1	View file
drivers/ata/libahci.c	modified	+1	−1	View file
drivers/ata/libata-core.c	modified	+1	−1	View file
drivers/ata/libata-eh.c	modified	+1	−1	View file
drivers/ata/libata-scsi.c	modified	+5	−4	View file
drivers/ata/libata-sff.c	modified	+1	−1	View file
drivers/ata/libata.h	modified	+1	−1	View file
drivers/ata/pata_pdc2027x.c	modified	+1	−1	View file
drivers/ata/pdc_adma.c	modified	+1	−1	View file
drivers/ata/sata_nv.c	modified	+1	−1	View file
drivers/ata/sata_promise.c	modified	+1	−1	View file
drivers/ata/sata_promise.h	modified	+1	−1	View file
drivers/ata/sata_qstor.c	modified	+1	−1	View file
drivers/ata/sata_sil.c	modified	+1	−1	View file
drivers/ata/sata_sis.c	modified	+1	−1	View file
drivers/ata/sata_svw.c	modified	+1	−1	View file
drivers/ata/sata_sx4.c	modified	+1	−1	View file
drivers/ata/sata_uli.c	modified	+1	−1	View file
drivers/ata/sata_via.c	modified	+1	−1	View file
drivers/ata/sata_vsc.c	modified	+1	−1	View file
drivers/mtd/nand/nand_base.c	modified	+5	−2	View file
drivers/net/phy/phy.c	modified	+1	−0	View file
drivers/scsi/qla1280.c	modified	+1	−1	View file
drivers/scsi/scsi_scan.c	modified	+4	−3	View file
drivers/scsi/scsi_transport_fc.c	modified	+10	−8	View file
drivers/scsi/scsicam.c	modified	+2	−2	View file
fs/debugfs/file.c	modified	+1	−1	View file
fs/debugfs/inode.c	modified	+1	−1	View file
fs/eventfd.c	modified	+2	−2	View file
fs/fs-writeback.c	modified	+7	−5	View file
fs/jbd2/transaction.c	modified	+21	−21	View file
fs/mpage.c	modified	+1	−0	View file
fs/namei.c	modified	+1	−0	View file
include/linux/ata.h	modified	+1	−1	View file
include/linux/cred.h	modified	+1	−1	View file
include/linux/debugfs.h	modified	+1	−1	View file
include/linux/key.h	modified	+1	−1	View file
include/linux/libata.h	modified	+1	−1	View file
include/linux/lsm_hooks.h	modified	+12	−13	View file
include/linux/mtd/nand.h	modified	+1	−1	View file
include/linux/mutex.h	modified	+3	−3	View file
include/linux/netdevice.h	modified	+5	−4	View file
include/linux/skbuff.h	modified	+1	−1	View file
include/net/sock.h	modified	+4	−5	View file
kernel/cred.c	modified	+1	−1	View file
kernel/futex.c	modified	+20	−20	View file
kernel/irq/chip.c	modified	+1	−1	View file
kernel/irq/handle.c	modified	+1	−1	View file
kernel/irq/irqdesc.c	modified	+1	−1	View file
kernel/locking/mutex.c	modified	+3	−3	View file
lib/Kconfig.debug	modified	+1	−1	View file
lib/Kconfig.kgdb	modified	+1	−1	View file
net/core/datagram.c	modified	+1	−1	View file
net/core/sock.c	modified	+5	−2	View file
scripts/.gitignore	modified	+0	−1	View file
scripts/Makefile	modified	+2	−8	View file
scripts/check-lc_ctype.c	deleted	+0	−11	View before deletion
scripts/docproc.c	deleted	+0	−681	View before deletion
scripts/kernel-doc	modified	+2	−0	View file
scripts/kernel-doc-xml-ref	deleted	+0	−198	View before deletion
scripts/selinux/README	modified	+1	−1	View file
security/apparmor/match.c	modified	+1	−1	View file
security/apparmor/policy_unpack.c	modified	+1	−1	View file
security/keys/encrypted-keys/encrypted.c	modified	+1	−1	View file
security/keys/encrypted-keys/masterkey_trusted.c	modified	+1	−1	View file
security/keys/request_key.c	modified	+1	−1	View file
security/keys/request_key_auth.c	modified	+1	−1	View file
security/keys/trusted.c	modified	+1	−1	View file
security/yama/Kconfig	modified	+2	−1	View file

Only the first 600 diff lines are shown. Download the complete patch.

Documentation/00-INDEX

View file

diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index ed3e5e9..f35473f 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -24,8 +24,6 @@ DMA-ISA-LPC.txt
 	- How to do DMA with ISA (and LPC) devices.
 DMA-attributes.txt
 	- listing of the various possible attributes a DMA region can have
-DocBook/
-	- directory with DocBook templates etc. for kernel documentation.
 EDID/
 	- directory with info on customizing EDID for broken gfx/displays.
 IPMI.txt
@@ -40,8 +38,6 @@ Intel-IOMMU.txt
 	- basic info on the Intel IOMMU virtualization support.
 Makefile
 	- It's not of interest for those who aren't touching the build system.
-Makefile.sphinx
-	- It's not of interest for those who aren't touching the build system.
 PCI/
 	- info related to PCI drivers.
 RCU/
@@ -264,6 +260,8 @@ logo.gif
 	- full colour GIF image of Linux logo (penguin - Tux).
 logo.txt
 	- info on creator of above logo & site to get additional images from.
+lsm.txt
+	- Linux Security Modules: General Security Hooks for Linux
 lzo.txt
 	- kernel LZO decompressor input formats
 m68k/

Documentation/DMA-API.txt

View file

diff --git a/Documentation/DMA-API.txt b/Documentation/DMA-API.txt
index 6b20128..71200df 100644
--- a/Documentation/DMA-API.txt
+++ b/Documentation/DMA-API.txt
@@ -692,7 +692,7 @@ of preallocated entries is defined per architecture. If it is too low for you
 boot with 'dma_debug_entries=<your_desired_number>' to overwrite the
 architectural default.
 
-void debug_dmap_mapping_error(struct device *dev, dma_addr_t dma_addr);
+void debug_dma_mapping_error(struct device *dev, dma_addr_t dma_addr);
 
 dma-debug interface debug_dma_mapping_error() to debug drivers that fail
 to check DMA mapping errors on addresses returned by dma_map_single() and

Documentation/DocBook/.gitignore

View before deletion

diff --git a/Documentation/DocBook/.gitignore b/Documentation/DocBook/.gitignore
deleted file mode 100644
index e05da3f..0000000
--- a/Documentation/DocBook/.gitignore
+++ /dev/null
@@ -1,17 +0,0 @@
-*.xml
-*.ps
-*.pdf
-*.html
-*.9.gz
-*.9
-*.aux
-*.dvi
-*.log
-*.out
-*.png
-*.gif
-*.svg
-*.proc
-*.db
-media-indices.tmpl
-media-entities.tmpl

Documentation/DocBook/Makefile

View before deletion

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
deleted file mode 100644
index 85916f1..0000000
--- a/Documentation/DocBook/Makefile
+++ /dev/null
@@ -1,282 +0,0 @@
-###
-# This makefile is used to generate the kernel documentation,
-# primarily based on in-line comments in various source files.
-# See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how
-# to document the SRC - and how to read it.
-# To add a new book the only step required is to add the book to the
-# list of DOCBOOKS.
-
-DOCBOOKS := z8530book.xml  \
-	    kernel-hacking.xml kernel-locking.xml \
-	    networking.xml \
-	    filesystems.xml lsm.xml kgdb.xml \
-	    libata.xml mtdnand.xml librs.xml rapidio.xml \
-	    s390-drivers.xml scsi.xml \
-	    sh.xml w1.xml
-
-ifeq ($(DOCBOOKS),)
-
-# Skip DocBook build if the user explicitly requested no DOCBOOKS.
-.DEFAULT:
-	@echo "  SKIP    DocBook $@ target (DOCBOOKS=\"\" specified)."
-else
-ifneq ($(SPHINXDIRS),)
-
-# Skip DocBook build if the user explicitly requested a sphinx dir
-.DEFAULT:
-	@echo "  SKIP    DocBook $@ target (SPHINXDIRS specified)."
-else
-
-
-###
-# The build process is as follows (targets):
-#              (xmldocs) [by docproc]
-# file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto]
-#                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto]
-#                        +--> DIR=file  (htmldocs) [by xmlto]
-#                        +--> man/      (mandocs)  [by xmlto]
-
-
-# for PDF and PS output you can choose between xmlto and docbook-utils tools
-PDF_METHOD	= $(prefer-db2x)
-PS_METHOD	= $(prefer-db2x)
-
-
-targets += $(DOCBOOKS)
-BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
-xmldocs: $(BOOKS)
-sgmldocs: xmldocs
-
-PS := $(patsubst %.xml, %.ps, $(BOOKS))
-psdocs: $(PS)
-
-PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
-pdfdocs: $(PDF)
-
-HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
-htmldocs: $(HTML)
-	$(call cmd,build_main_index)
-
-MAN := $(patsubst %.xml, %.9, $(BOOKS))
-mandocs: $(MAN)
-	find $(obj)/man -name '*.9' | xargs gzip -nf
-
-# Default location for installed man pages
-export INSTALL_MAN_PATH = $(objtree)/usr
-
-installmandocs: mandocs
-	mkdir -p $(INSTALL_MAN_PATH)/man/man9/
-	find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \
-		sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
-		xargs install -m 644 -t $(INSTALL_MAN_PATH)/man/man9/
-
-# no-op for the DocBook toolchain
-epubdocs:
-latexdocs:
-linkcheckdocs:
-
-###
-#External programs used
-KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
-KERNELDOC       = $(srctree)/scripts/kernel-doc
-DOCPROC         = $(objtree)/scripts/docproc
-CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype
-
-# Use a fixed encoding - UTF-8 if the C library has support built-in
-# or ASCII if not
-LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C)
-export LC_CTYPE
-
-XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
-XMLTOFLAGS += --skip-validation
-
-###
-# DOCPROC is used for two purposes:
-# 1) To generate a dependency list for a .tmpl file
-# 2) To preprocess a .tmpl file and call kernel-doc with
-#     appropriate parameters.
-# The following rules are used to generate the .xml documentation
-# required to generate the final targets. (ps, pdf, html).
-quiet_cmd_docproc = DOCPROC $@
-      cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
-define rule_docproc
-	set -e;								\
-        $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';) 	\
-        $(cmd_$(1)); 							\
-        ( 								\
-          echo 'cmd_$@ := $(cmd_$(1))'; 				\
-          echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; 		\
-        ) > $(dir $@).$(notdir $@).cmd
-endef
-
-%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
-	$(call if_changed_rule,docproc)
-
-# Tell kbuild to always build the programs
-always := $(hostprogs-y)
-
-notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
-		   exit 1
-db2xtemplate = db2TYPE -o $(dir $@) $<
-xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
-
-# determine which methods are available
-ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
-	use-db2x = db2x
-	prefer-db2x = db2x
-else
-	use-db2x = notfound
-	prefer-db2x = $(use-xmlto)
-endif
-ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
-	use-xmlto = xmlto
-	prefer-xmlto = xmlto
-else
-	use-xmlto = notfound
-	prefer-xmlto = $(use-db2x)
-endif
-
-# the commands, generated from the chosen template
-quiet_cmd_db2ps = PS      $@
-      cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
-%.ps : %.xml
-	$(call cmd,db2ps)
-
-quiet_cmd_db2pdf = PDF     $@
-      cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
-%.pdf : %.xml
-	$(call cmd,db2pdf)
-
-
-index = index.html
-main_idx = $(obj)/$(index)
-quiet_cmd_build_main_index = HTML    $(main_idx)
-      cmd_build_main_index = rm -rf $(main_idx); \
-		   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
-		   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
-		   cat $(HTML) >> $(main_idx)
-
-quiet_cmd_db2html = HTML    $@
-      cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
-		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
-		$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
-
-###
-# Rules to create an aux XML and .db, and use them to re-process the DocBook XML
-# to fill internal hyperlinks
-       gen_aux_xml = :
- quiet_gen_aux_xml = echo '  XMLREF  $@'
-silent_gen_aux_xml = :
-%.aux.xml: %.xml
-	@$($(quiet)gen_aux_xml)
-	@rm -rf $@
-	@(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db)
-	@$(KERNELDOCXMLREF) -db $<.db $< > $@
-.PRECIOUS: %.aux.xml
-
-%.html:	%.aux.xml
-	@(which xmlto > /dev/null 2>&1) || \
-	 (echo "*** You need to install xmlto ***"; \
-	  exit 1)
-	@rm -rf $@ $(patsubst %.html,%,$@)
-	$(call cmd,db2html)
-	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
-            cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
-
-quiet_cmd_db2man = MAN     $@
-      cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
-%.9 : %.xml
-	@(which xmlto > /dev/null 2>&1) || \
-	 (echo "*** You need to install xmlto ***"; \
-	  exit 1)
-	$(Q)mkdir -p $(obj)/man/$(*F)
-	$(call cmd,db2man)
-	@touch $@
-
-###
-# Rules to generate postscripts and PNG images from .fig format files
-quiet_cmd_fig2eps = FIG2EPS $@
-      cmd_fig2eps = fig2dev -Leps $< $@
-
-%.eps: %.fig
-	@(which fig2dev > /dev/null 2>&1) || \
-	 (echo "*** You need to install transfig ***"; \
-	  exit 1)
-	$(call cmd,fig2eps)
-
-quiet_cmd_fig2png = FIG2PNG $@
-      cmd_fig2png = fig2dev -Lpng $< $@
-
-%.png: %.fig
-	@(which fig2dev > /dev/null 2>&1) || \
-	 (echo "*** You need to install transfig ***"; \
-	  exit 1)
-	$(call cmd,fig2png)
-
-###
-# Rule to convert a .c file to inline XML documentation
-       gen_xml = :
- quiet_gen_xml = echo '  GEN     $@'
-silent_gen_xml = :
-%.xml: %.c
-	@$($(quiet)gen_xml)
-	@(                            \
-	   echo "<programlisting>";   \
-	   expand --tabs=8 < $< |     \
-	   sed -e "s/&/\\&amp;/g"     \
-	       -e "s/</\\&lt;/g"      \
-	       -e "s/>/\\&gt;/g";     \
-	   echo "</programlisting>")  > $@
-
-endif # DOCBOOKS=""
-endif # SPHINDIR=...
-
-###
-# Help targets as used by the top-level makefile
-dochelp:
-	@echo  ' Linux kernel internal documentation in different formats (DocBook):'
-	@echo  '  htmldocs        - HTML'
-	@echo  '  pdfdocs         - PDF'
-	@echo  '  psdocs          - Postscript'
-	@echo  '  xmldocs         - XML DocBook'
-	@echo  '  mandocs         - man pages'
-	@echo  '  installmandocs  - install man pages generated by mandocs to INSTALL_MAN_PATH'; \
-	 echo  '                    (default: $(INSTALL_MAN_PATH))'; \
-	 echo  ''
-	@echo  '  cleandocs       - clean all generated DocBook files'
-	@echo
-	@echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
-	@echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
-	@echo
-	@echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
-	@echo  '     This is useful to generate only the ReST docs (Sphinx)'
-
-
-###
-# Temporary files left by various tools
-clean-files := $(DOCBOOKS) \
-	$(patsubst %.xml, %.dvi,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.aux,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.tex,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.log,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.out,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.ps,      $(DOCBOOKS)) \
-	$(patsubst %.xml, %.pdf,     $(DOCBOOKS)) \
-	$(patsubst %.xml, %.html,    $(DOCBOOKS)) \
-	$(patsubst %.xml, %.9,       $(DOCBOOKS)) \
-	$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
-	$(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
-	$(patsubst %.xml, %.xml,     $(DOCBOOKS)) \
-	$(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \
-	$(index)
-
-clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
-
-cleandocs:
-	$(Q)rm -f $(call objectify, $(clean-files))
-	$(Q)rm -rf $(call objectify, $(clean-dirs))
-
-# Declare the contents of the .PHONY variable as phony.  We keep that
-# information in a variable so we can use it in if_changed and friends.
-
-.PHONY: $(PHONY)

Documentation/DocBook/filesystems.tmpl

View before deletion

diff --git a/Documentation/DocBook/filesystems.tmpl b/Documentation/DocBook/filesystems.tmpl
deleted file mode 100644
index 6006b63..0000000
--- a/Documentation/DocBook/filesystems.tmpl
+++ /dev/null
@@ -1,381 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
-
-<book id="Linux-filesystems-API">
- <bookinfo>
-  <title>Linux Filesystems API</title>
-
-  <legalnotice>
-   <para>
-     This documentation is free software; you can redistribute
-     it and/or modify it under the terms of the GNU General Public
-     License as published by the Free Software Foundation; either
-     version 2 of the License, or (at your option) any later
-     version.
-   </para>
-
-   <para>
-     This program is distributed in the hope that it will be
-     useful, but WITHOUT ANY WARRANTY; without even the implied
-     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-     See the GNU General Public License for more details.
-   </para>
-
-   <para>
-     You should have received a copy of the GNU General Public
-     License along with this program; if not, write to the Free
-     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-     MA 02111-1307 USA
-   </para>
-
-   <para>
-     For more details see the file COPYING in the source
-     distribution of Linux.
-   </para>
-  </legalnotice>
- </bookinfo>
-
-<toc></toc>
-
-  <chapter id="vfs">
-     <title>The Linux VFS</title>
-     <sect1 id="the_filesystem_types"><title>The Filesystem types</title>
-!Iinclude/linux/fs.h
-     </sect1>
-     <sect1 id="the_directory_cache"><title>The Directory Cache</title>
-!Efs/dcache.c
-!Iinclude/linux/dcache.h
-     </sect1>
-     <sect1 id="inode_handling"><title>Inode Handling</title>
-!Efs/inode.c
-!Efs/bad_inode.c
-     </sect1>
-     <sect1 id="registration_and_superblocks"><title>Registration and Superblocks</title>
-!Efs/super.c
-     </sect1>
-     <sect1 id="file_locks"><title>File Locks</title>
-!Efs/locks.c
-!Ifs/locks.c
-     </sect1>
-     <sect1 id="other_functions"><title>Other Functions</title>
-!Efs/mpage.c
-!Efs/namei.c
-!Efs/buffer.c
-!Eblock/bio.c
-!Efs/seq_file.c
-!Efs/filesystems.c
-!Efs/fs-writeback.c
-!Efs/block_dev.c
-     </sect1>
-  </chapter>
-
-  <chapter id="proc">
-     <title>The proc filesystem</title>
-
-     <sect1 id="sysctl_interface"><title>sysctl interface</title>
-!Ekernel/sysctl.c
-     </sect1>
-
-     <sect1 id="proc_filesystem_interface"><title>proc filesystem interface</title>
-!Ifs/proc/base.c
-     </sect1>
-  </chapter>
-
-  <chapter id="fs_events">
-     <title>Events based on file descriptors</title>
-!Efs/eventfd.c
-  </chapter>
-
-  <chapter id="sysfs">
-     <title>The Filesystem for Exporting Kernel Objects</title>
-!Efs/sysfs/file.c
-!Efs/sysfs/symlink.c
-  </chapter>
-
-  <chapter id="debugfs">
-     <title>The debugfs filesystem</title>
-
-     <sect1 id="debugfs_interface"><title>debugfs interface</title>
-!Efs/debugfs/inode.c
-!Efs/debugfs/file.c
-     </sect1>
-  </chapter>
-
-  <chapter id="LinuxJDBAPI">
-  <chapterinfo>
-  <title>The Linux Journalling API</title>
-
-  <authorgroup>
-  <author>
-     <firstname>Roger</firstname>
-     <surname>Gammans</surname>
-     <affiliation>
-     <address>
-      <email>[email protected]</email>
-     </address>
-    </affiliation>
-     </author>
-  </authorgroup>
-
-  <authorgroup>
-   <author>
-    <firstname>Stephen</firstname>
-    <surname>Tweedie</surname>
-    <affiliation>
-     <address>
-      <email>[email protected]</email>
-     </address>
-    </affiliation>
-   </author>
-  </authorgroup>
-
-  <copyright>
-   <year>2002</year>
-   <holder>Roger Gammans</holder>
-  </copyright>
-  </chapterinfo>
-
-  <title>The Linux Journalling API</title>
-
-    <sect1 id="journaling_overview">
-     <title>Overview</title>
-    <sect2 id="journaling_details">
-     <title>Details</title>
-<para>
-The journalling layer is  easy to use. You need to
-first of all create a journal_t data structure. There are
-two calls to do this dependent on how you decide to allocate the physical
-media on which the journal resides. The jbd2_journal_init_inode() call
-is for journals stored in filesystem inodes, or the jbd2_journal_init_dev()
-call can be used for journal stored on a raw device (in a continuous range
-of blocks). A journal_t is a typedef for a struct pointer, so when
-you are finally finished make sure you call jbd2_journal_destroy() on it
-to free up any used kernel memory.
-</para>
-
-<para>
-Once you have got your journal_t object you need to 'mount' or load the journal
-file. The journalling layer expects the space for the journal was already
-allocated and initialized properly by the userspace tools.  When loading the
-journal you must call jbd2_journal_load() to process journal contents.  If the
-client file system detects the journal contents does not need to be processed
-(or even need not have valid contents), it may call jbd2_journal_wipe() to
-clear the journal contents before calling jbd2_journal_load().
-</para>
-
-<para>
-Note that jbd2_journal_wipe(..,0) calls jbd2_journal_skip_recovery() for you if
-it detects any outstanding transactions in the journal and similarly
-jbd2_journal_load() will call jbd2_journal_recover() if necessary.  I would
-advise reading ext4_load_journal() in fs/ext4/super.c for examples on this
-stage.
-</para>
-
-<para>
-Now you can go ahead and start modifying the underlying
-filesystem. Almost.
-</para>
-
-<para>
-
-You still need to actually journal your filesystem changes, this
-is done by wrapping them into transactions. Additionally you
-also need to wrap the modification of each of the buffers
-with calls to the journal layer, so it knows what the modifications
-you are actually making are. To do this use jbd2_journal_start() which
-returns a transaction handle.
-</para>
-
-<para>
-jbd2_journal_start()
-and its counterpart jbd2_journal_stop(), which indicates the end of a
-transaction are nestable calls, so you can reenter a transaction if necessary,
-but remember you must call jbd2_journal_stop() the same number of times as
-jbd2_journal_start() before the transaction is completed (or more accurately
-leaves the update phase). Ext4/VFS makes use of this feature to simplify
-handling of inode dirtying, quota support, etc.
-</para>
-
-<para>
-Inside each transaction you need to wrap the modifications to the
-individual buffers (blocks). Before you start to modify a buffer you
-need to call jbd2_journal_get_{create,write,undo}_access() as appropriate,
-this allows the journalling layer to copy the unmodified data if it
-needs to. After all the buffer may be part of a previously uncommitted
-transaction.
-At this point you are at last ready to modify a buffer, and once
-you are have done so you need to call jbd2_journal_dirty_{meta,}data().
-Or if you've asked for access to a buffer you now know is now longer
-required to be pushed back on the device you can call jbd2_journal_forget()
-in much the same way as you might have used bforget() in the past.
-</para>
-
-<para>
-A jbd2_journal_flush() may be called at any time to commit and checkpoint
-all your transactions.
-</para>
-
-<para>
-Then at umount time , in your put_super() you can then call jbd2_journal_destroy()
-to clean up your in-core journal object.
-</para>
-
-<para>
-Unfortunately there a couple of ways the journal layer can cause a deadlock.
-The first thing to note is that each task can only have
-a single outstanding transaction at any one time, remember nothing
-commits until the outermost jbd2_journal_stop(). This means
-you must complete the transaction at the end of each file/inode/address
-etc. operation you perform, so that the journalling system isn't re-entered
-on another journal. Since transactions can't be nested/batched
-across differing journals, and another filesystem other than
-yours (say ext4) may be modified in a later syscall.
-</para>
-
-<para>
-The second case to bear in mind is that jbd2_journal_start() can
-block if there isn't enough space in the journal for your transaction
-(based on the passed nblocks param) - when it blocks it merely(!) needs to