Skip to contentSkip to conversation

proc: remove docbook and example

PATCH In review Alexey Dobriyan 2 participants 2 messages Nov 27, 2009 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 proc: remove docbook and example

Example is outdated, it still uses old ->read_proc interfaces and "fb" example is plain racy.
There are better examples all over the tree.

Docbook itself says almost nothing about /proc
and contain quite a number of simply wrong facts, e.g. device nodes support. What it does is describing at great length interface which are going to be removed.

There are Documentation/filesystems/seq_file.txt in exchange.

---

 Documentation/DocBook/Makefile          |   17 
 Documentation/DocBook/procfs-guide.tmpl |  626 --------------------------------
 Documentation/DocBook/procfs_example.c  |  201 ----------
 3 files changed, 3 insertions(+), 841 deletions(-)
Documentation/DocBook/Makefile +3 -14
@@ -8,7 +8,7 @@
 
 DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
 	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
-	    procfs-guide.xml writing_usb_driver.xml networking.xml \
+	    writing_usb_driver.xml networking.xml \
 	    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
 	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
 	    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
@@ -65,7 +65,7 @@ KERNELDOC = $(srctree)/scripts/kernel-doc
 DOCPROC   = $(objtree)/scripts/basic/docproc
 
 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
-#XMLTOFLAGS += --skip-validation
+XMLTOFLAGS += --skip-validation
 
 ###
 # DOCPROC is used for two purposes:
@@ -101,17 +101,6 @@ endif
 # Changes in kernel-doc force a rebuild of all documentation
 $(BOOKS): $(KERNELDOC)
 
-###
-# procfs guide uses a .c file as example code.
-# This requires an explicit dependency
-C-procfs-example = procfs_example.xml
-C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
-$(obj)/procfs-guide.xml: $(C-procfs-example2)
-
-# List of programs to build
-##oops, this is a kernel module::hostprogs-y := procfs_example
-obj-m += procfs_example.o
-
 # Tell kbuild to always build the programs
 always := $(hostprogs-y)
 
@@ -238,7 +227,7 @@ clean-files := $(DOCBOOKS) \
 	$(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
 	$(patsubst %.xml, %.html, $(DOCBOOKS)) \
 	$(patsubst %.xml, %.9,    $(DOCBOOKS)) \
-	$(C-procfs-example) $(index)
+	$(index)
 
 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 

deleted file mode 100644

Documentation/DocBook/procfs-guide.tmpl deleted +0 -626

626 lines not on this page · raw message

deleted file mode 100644

Documentation/DocBook/procfs_example.c deleted +0 -201

201 lines not on this page · raw message

#1 lore raw
Quoted 3 lines · On Fri, 27 Nov 2009 10:03:31 +0300 Alexey Dobriyan <[email protected]> wrote:

Example is outdated, it still uses old ->read_proc interfaces and "fb" example is plain racy.
There are better examples all over the tree.

Agreed, it was written back in the early 2.4 days. Time moves on.

Quoted 4 lines

Docbook itself says almost nothing about /proc
and contain quite a number of simply wrong facts, e.g. device nodes support. What it does is describing at great length interface which are going to be removed.

I always had plans to update the documentation but never could set myself to do it.

Quoted 1 line

There are Documentation/filesystems/seq_file.txt in exchange.

Great, updated/newer documentation. Just remove the procfs documentation and examples.

Quoted 1 line

Regards,

Erik

Signature · 2 lines
Erik Mouw -- [email protected]
GPG key fingerprint: D6AC 7F15 A26E C5C4 62E0  4A58 FCF9 551C 9B48 B68D