Skip to contentSkip to conversation

docbook: make a networking book and fix a few errors

PATCH In review Randy Dunlap 1 participant 1 message Feb 12, 2008

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 4/4 docbook: make a networking book and fix a few errors

From: Randy Dunlap <[email protected]>

Move networking (core and drivers) docbook to its own networking book. Fix a few kernel-doc errors in header and source files.

---
 Documentation/DocBook/Makefile        |    2 
 Documentation/DocBook/kernel-api.tmpl |   65 --------------------
 Documentation/DocBook/networking.tmpl |  106 ++++++++++++++++++++++++++++++++++
 include/linux/etherdevice.h           |    3 
 net/core/dev.c                        |    3 
 net/core/skbuff.c                     |    4 -
 6 files changed, 111 insertions(+), 72 deletions(-)
include/linux/etherdevice.h +1 -2
@@ -70,8 +70,7 @@ static inline int is_multicast_ether_add
 }
 
 /**
- * is_local_ether_addr - Determine if the Ethernet address is locally-assigned
- * one (IEEE 802).
+ * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
  * @addr: Pointer to a six-byte array containing the Ethernet address
  *
  * Return true if the address is a local address.
net/core/dev.c +1 -2
@@ -3038,8 +3038,7 @@ int dev_unicast_sync(struct net_device *
 EXPORT_SYMBOL(dev_unicast_sync);
 
 /**
- *	dev_unicast_unsync - Remove synchronized addresses from the destination
- *			     device
+ *	dev_unicast_unsync - Remove synchronized addresses from the destination device
  *	@to: destination device
  *	@from: source device
  *
net/core/skbuff.c +2 -2
@@ -1907,11 +1907,11 @@ void skb_prepare_seq_read(struct sk_buff
  * of bytes already consumed and the next call to
  * skb_seq_read() will return the remaining part of the block.
  *
- * Note: The size of each block of data returned can be arbitary,
+ * Note 1: The size of each block of data returned can be arbitary,
  *       this limitation is the cost for zerocopy seqeuental
  *       reads of potentially non linear data.
  *
- * Note: Fragment lists within fragments are not implemented
+ * Note 2: Fragment lists within fragments are not implemented
  *       at the moment, state->root_skb could be replaced with
  *       a stack for this purpose.
  */
Documentation/DocBook/Makefile +1 -1
@@ -8,7 +8,7 @@
 
 DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
 	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
-	    procfs-guide.xml writing_usb_driver.xml \
+	    procfs-guide.xml writing_usb_driver.xml networking.xml \
 	    kernel-api.xml filesystems.xml lsm.xml usb.xml \
 	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
 	    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml
Documentation/DocBook/networking.tmpl new file +106 -0

106 lines not on this page · raw message

Documentation/DocBook/kernel-api.tmpl +0 -65

71 lines not on this page · raw message