linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation fixes
@ 2004-12-23 23:09 Martin Waitz
  0 siblings, 0 replies; 6+ messages in thread
From: Martin Waitz @ 2004-12-23 23:09 UTC (permalink / raw)
  To: linux-kernel

[-- Attachment #1: Type: text/plain, Size: 14759 bytes --]

hoi :)

The patch below fixes some warnings I get while updating my online
version of the Linux DocBook Documentation.

I don't have deep knowledge of all those subsystems, so please provide
better comments here :)

Index: drivers/block/ll_rw_blk.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/drivers/block/ll_rw_blk.c,v
retrieving revision 1.264
diff -u -p -r1.264 ll_rw_blk.c
--- drivers/block/ll_rw_blk.c	2 Dec 2004 01:09:52 -0000	1.264
+++ drivers/block/ll_rw_blk.c	23 Dec 2004 21:55:05 -0000
@@ -618,6 +618,7 @@ fail:
  * blk_queue_init_tags - initialize the queue tag info
  * @q:  the request queue for the device
  * @depth:  the maximum queue depth supported
+ * @tags: the tag to use
  **/
 int blk_queue_init_tags(request_queue_t *q, int depth,
 			struct blk_queue_tag *tags)
@@ -1934,7 +1935,7 @@ EXPORT_SYMBOL(blk_rq_map_user);
 /**
  * blk_rq_unmap_user - unmap a request with user data
  * @rq:		request to be unmapped
- * @ubuf:	user buffer
+ * @bio:	bio for the request
  * @ulen:	length of user buffer
  *
  * Description:
Index: drivers/net/8390.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/drivers/net/8390.c,v
retrieving revision 1.24
diff -u -p -r1.24 8390.c
--- drivers/net/8390.c	30 Oct 2004 11:59:58 -0000	1.24
+++ drivers/net/8390.c	23 Dec 2004 21:41:43 -0000
@@ -1002,6 +1002,7 @@ static void ethdev_setup(struct net_devi
 
 /**
  * alloc_ei_netdev - alloc_etherdev counterpart for 8390
+ * @size: extra bytes to allocate
  *
  * Allocate 8390-specific net_device.
  */
Index: drivers/usb/core/hcd.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/drivers/usb/core/hcd.c,v
retrieving revision 1.65
diff -u -p -r1.65 hcd.c
--- drivers/usb/core/hcd.c	13 Nov 2004 19:29:18 -0000	1.65
+++ drivers/usb/core/hcd.c	23 Dec 2004 22:50:14 -0000
@@ -1435,7 +1435,7 @@ static int hcd_hub_resume (struct usb_bu
 /**
  * usb_bus_start_enum - start immediate enumeration (for OTG)
  * @bus: the bus (must use hcd framework)
- * @port: 1-based number of port; usually bus->otg_port
+ * @port_num: 1-based number of port; usually bus->otg_port
  * Context: in_interrupt()
  *
  * Starts enumeration, with an immediate reset followed later by
Index: drivers/usb/core/hub.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/drivers/usb/core/hub.c,v
retrieving revision 1.73
diff -u -p -r1.73 hub.c
--- drivers/usb/core/hub.c	13 Nov 2004 19:29:18 -0000	1.73
+++ drivers/usb/core/hub.c	23 Dec 2004 22:49:47 -0000
@@ -368,7 +368,7 @@ static void hub_tt_kevent (void *arg)
 
 /**
  * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
- * @dev: the device whose split transaction failed
+ * @udev: the device whose split transaction failed
  * @pipe: identifies the endpoint of the failed transaction
  *
  * High speed HCDs use this to tell the hub driver that some split control or
Index: drivers/video/fbmem.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/drivers/video/fbmem.c,v
retrieving revision 1.114
diff -u -p -r1.114 fbmem.c
--- drivers/video/fbmem.c	29 Nov 2004 21:39:21 -0000	1.114
+++ drivers/video/fbmem.c	23 Dec 2004 22:23:37 -0000
@@ -1173,9 +1173,10 @@ static int ofonly;
 
 /**
  * fb_get_options - get kernel boot parameters
- * @name - framebuffer name as it would appear in
- *         the boot parameter line
- *         (video=<name>:<options>)
+ * @name:   framebuffer name as it would appear in
+ *          the boot parameter line
+ *          (video=<name>:<options>)
+ * @option: the option will be stored here
  *
  * NOTE: Needed to maintain backwards compatibility
  */
Index: fs/super.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/fs/super.c,v
retrieving revision 1.120
diff -u -p -r1.120 super.c
--- fs/super.c	20 Oct 2004 01:26:30 -0000	1.120
+++ fs/super.c	23 Dec 2004 20:30:53 -0000
@@ -141,7 +141,7 @@ int __put_super_and_need_restart(struct 
 
 /**
  *	put_super	-	drop a temporary reference to superblock
- *	@s: superblock in question
+ *	@sb: superblock in question
  *
  *	Drops a temporary reference, frees superblock if there's no
  *	references left.
Index: fs/jbd/journal.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/fs/jbd/journal.c,v
retrieving revision 1.80
diff -u -p -r1.80 journal.c
--- fs/jbd/journal.c	11 Nov 2004 21:40:50 -0000	1.80
+++ fs/jbd/journal.c	23 Dec 2004 22:39:19 -0000
@@ -1147,6 +1147,10 @@ void journal_destroy(journal_t *journal)
 
 /**
  *int journal_check_used_features () - Check if features specified are used.
+ * @journal: Journal to check.
+ * @compat: bitmask of compatible features
+ * @ro: bitmask of features that force read-only mount
+ * @incompat: bitmask of incompatible features
  * 
  * Check whether the journal uses all of a given set of
  * features.  Return true (non-zero) if it does. 
@@ -1174,6 +1178,10 @@ int journal_check_used_features (journal
 
 /**
  * int journal_check_available_features() - Check feature set in journalling layer
+ * @journal: Journal to check.
+ * @compat: bitmask of compatible features
+ * @ro: bitmask of features that force read-only mount
+ * @incompat: bitmask of incompatible features
  * 
  * Check whether the journaling code supports the use of
  * all of a given set of features on this journal.  Return true
@@ -1206,6 +1214,10 @@ int journal_check_available_features (jo
 
 /**
  * int journal_set_features () - Mark a given journal feature in the superblock
+ * @journal: Journal to act on.
+ * @compat: bitmask of compatible features
+ * @ro: bitmask of features that force read-only mount
+ * @incompat: bitmask of incompatible features
  *
  * Mark a given journal feature as present on the
  * superblock.  Returns true if the requested features could be set. 
@@ -1238,6 +1250,7 @@ int journal_set_features (journal_t *jou
 
 /**
  * int journal_update_format () - Update on-disk journal structure.
+ * @journal: Journal to act on.
  *
  * Given an initialised but unloaded journal struct, poke about in the
  * on-disk structure to update it to the most recent supported version.
@@ -1538,6 +1551,7 @@ int journal_errno(journal_t *journal)
 
 /** 
  * int journal_clear_err () - clears the journal's error state
+ * @journal: journal to act on.
  *
  * An error must be cleared or Acked to take a FS out of readonly
  * mode.
@@ -1557,6 +1571,7 @@ int journal_clear_err(journal_t *journal
 
 /** 
  * void journal_ack_err() - Ack journal err.
+ * @journal: journal to act on.
  *
  * An error must be cleared or Acked to take a FS out of readonly
  * mode.
@@ -1578,10 +1593,6 @@ int journal_blocks_per_page(struct inode
  * Simple support for retying memory allocations.  Introduced to help to
  * debug different VM deadlock avoidance strategies. 
  */
-/*
- * Simple support for retying memory allocations.  Introduced to help to
- * debug different VM deadlock avoidance strategies. 
- */
 void * __jbd_kmalloc (const char *where, size_t size, int flags, int retry)
 {
 	return kmalloc(size, flags | (retry ? __GFP_NOFAIL : 0));
Index: fs/jbd/transaction.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/fs/jbd/transaction.c,v
retrieving revision 1.91
diff -u -p -r1.91 transaction.c
--- fs/jbd/transaction.c	8 Nov 2004 04:02:44 -0000	1.91
+++ fs/jbd/transaction.c	23 Dec 2004 22:45:36 -0000
@@ -742,6 +742,7 @@ out:
  * int journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update.
  * @handle: transaction to add buffer modifications to
  * @bh:     bh to be used for metadata writes
+ * @credits: variable that will receive credits for the buffer
  *
  * Returns an error code or 0 on success.
  *
@@ -1570,7 +1571,7 @@ out:
  * int journal_try_to_free_buffers() - try to free page buffers.
  * @journal: journal for operation
  * @page: to try and free
- * @gfp_mask: 'IO' mode for try_to_free_buffers()
+ * @unused_gfp_mask: unused
  *
  * 
  * For all the buffers on this page,
Index: include/linux/jbd.h
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/include/linux/jbd.h,v
retrieving revision 1.48
diff -u -p -r1.48 jbd.h
--- include/linux/jbd.h	8 Nov 2004 04:02:44 -0000	1.48
+++ include/linux/jbd.h	23 Dec 2004 22:34:43 -0000
@@ -560,6 +560,7 @@ struct transaction_s 
  * @j_sb_buffer: First part of superblock buffer
  * @j_superblock: Second part of superblock buffer
  * @j_format_version: Version of the superblock format
+ * @j_state_lock: Protect the various scalars in the journal
  * @j_barrier_count:  Number of processes waiting to create a barrier lock
  * @j_barrier: The barrier lock itself
  * @j_running_transaction: The current running transaction..
@@ -587,6 +588,7 @@ struct transaction_s 
  * @j_fs_dev: Device which holds the client fs.  For internal journal this will
  *     be equal to j_dev
  * @j_maxlen: Total maximum capacity of the journal region on disk.
+ * @j_list_lock: Protects the buffer lists and internal buffer state.
  * @j_inode: Optional inode where we store the journal.  If present, all journal
  *     block numbers are mapped into this inode via bmap().
  * @j_tail_sequence:  Sequence number of the oldest transaction in the log 
@@ -602,8 +604,11 @@ struct transaction_s 
  * @j_commit_interval: What is the maximum transaction lifetime before we begin
  *  a commit?
  * @j_commit_timer:  The timer used to wakeup the commit thread
+ * @j_revoke_lock: Protect the revoke table
  * @j_revoke: The revoke table - maintains the list of revoked blocks in the
  *     current transaction.
+ * @j_revoke_table: alternate revoke tables for j_revoke
+ * @j_private: An opaque pointer to fs-private information.
  */
 
 struct journal_s
Index: include/linux/skbuff.h
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/include/linux/skbuff.h,v
retrieving revision 1.55
diff -u -p -r1.55 skbuff.h
--- include/linux/skbuff.h	7 Oct 2004 21:45:31 -0000	1.55
+++ include/linux/skbuff.h	23 Dec 2004 20:35:21 -0000
@@ -187,6 +187,8 @@ struct skb_shared_info {
  *	@nf_bridge: Saved data about a bridged frame - see br_netfilter.c
  *      @private: Data which is private to the HIPPI implementation
  *	@tc_index: Traffic control index
+ *	@tc_verd: traffic control verdict
+ *	@tc_classid: traffic control classid
  */
 
 struct sk_buff {
Index: kernel/sysctl.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/kernel/sysctl.c,v
retrieving revision 1.96
diff -u -p -r1.96 sysctl.c
--- kernel/sysctl.c	2 Nov 2004 23:04:07 -0000	1.96
+++ kernel/sysctl.c	23 Dec 2004 20:30:34 -0000
@@ -1355,6 +1355,7 @@ static ssize_t proc_writesys(struct file
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes a string from/to the user buffer. If the kernel
  * buffer provided is not large enough to hold the string, the
@@ -1571,6 +1572,7 @@ static int do_proc_dointvec(ctl_table *t
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned int) integer
  * values from/to the user buffer, treated as an ASCII string. 
@@ -1675,6 +1677,7 @@ static int do_proc_dointvec_minmax_conv(
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned int) integer
  * values from/to the user buffer, treated as an ASCII string.
@@ -1807,6 +1810,7 @@ static int do_proc_doulongvec_minmax(ctl
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned long) unsigned long
  * values from/to the user buffer, treated as an ASCII string.
@@ -1829,6 +1833,7 @@ int proc_doulongvec_minmax(ctl_table *ta
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned long) unsigned long
  * values from/to the user buffer, treated as an ASCII string. The values
@@ -1898,6 +1903,7 @@ static int do_proc_dointvec_userhz_jiffi
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned int) integer
  * values from/to the user buffer, treated as an ASCII string. 
@@ -1920,6 +1926,7 @@ int proc_dointvec_jiffies(ctl_table *tab
  * @filp: the file structure
  * @buffer: the user buffer
  * @lenp: the size of the user buffer
+ * @ppos: file position
  *
  * Reads/writes up to table->maxlen/sizeof(unsigned int) integer
  * values from/to the user buffer, treated as an ASCII string. 
Index: net/core/skbuff.c
===================================================================
RCS file: /home/martin/src/linux/linux-cvs/linux-2.5/net/core/skbuff.c,v
retrieving revision 1.39
diff -u -p -r1.39 skbuff.c
--- net/core/skbuff.c	30 Nov 2004 04:46:03 -0000	1.39
+++ net/core/skbuff.c	23 Dec 2004 21:06:22 -0000
@@ -1391,7 +1391,7 @@ static inline void skb_split_no_header(s
 
 			if (pos < len) {
 				/* Split frag.
-				 * We have to variants in this case:
+				 * We have two variants in this case:
 				 * 1. Move all the frag to the second
 				 *    part, if it is possible. F.e.
 				 *    this approach is mandatory for TUX,
@@ -1414,6 +1414,9 @@ static inline void skb_split_no_header(s
 
 /**
  * skb_split - Split fragmented skb to two parts at length len.
+ * @skb: the buffer to split
+ * @skb1: the buffer to receive the second part
+ * @len: new length for skb
  */
 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len)
 {


-- 
Martin Waitz

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] documentation fixes
  2007-07-31 20:14 ` Cal Peake
@ 2007-08-01  5:55   ` Ph. Marek
  0 siblings, 0 replies; 6+ messages in thread
From: Ph. Marek @ 2007-08-01  5:55 UTC (permalink / raw)
  To: Cal Peake; +Cc: linux-kernel

On Dienstag, 31. Juli 2007, Cal Peake wrote:
> > Whom should I CC for other documentation updates? Is the maintainer
> > the correct person, or are such small fixes "send and forget"?
>
> For spelling and grammar fixes, sending to trivial@kernel.org is prolly
> the best bet with a CC to l-k.
>
> Also, please see Documentation/SubmittingPatches, particularly section 12
> about signing off your work.
Ok, thank you!


Regards,

Phil

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] documentation fixes
  2007-07-31  9:14 [PATCH] documentation fixes Ph. Marek
@ 2007-07-31 20:14 ` Cal Peake
  2007-08-01  5:55   ` Ph. Marek
  0 siblings, 1 reply; 6+ messages in thread
From: Cal Peake @ 2007-07-31 20:14 UTC (permalink / raw)
  To: Ph. Marek; +Cc: linux-kernel

On Tue, 31 Jul 2007, Ph. Marek wrote:

> Hello everybody,
> 
> here are some small documentation fixes - mostly typing errors.
> 
> Please take a look at the last chunk - I think that klibc.bkbits.net 
> is no longer the current version, but I'm not sure whether the 
> other link is better.

git://git.kernel.org/pub/scm/libs/klibc/klibc.git should be a safe 
replacement

> Whom should I CC for other documentation updates? Is the maintainer 
> the correct person, or are such small fixes "send and forget"?

For spelling and grammar fixes, sending to trivial@kernel.org is prolly 
the best bet with a CC to l-k.

Also, please see Documentation/SubmittingPatches, particularly section 12 
about signing off your work.

cheers,
-- 
Cal Peake


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] documentation fixes
@ 2007-07-31  9:14 Ph. Marek
  2007-07-31 20:14 ` Cal Peake
  0 siblings, 1 reply; 6+ messages in thread
From: Ph. Marek @ 2007-07-31  9:14 UTC (permalink / raw)
  To: linux-kernel

Hello everybody,

here are some small documentation fixes - mostly typing errors.

Please take a look at the last chunk - I think that klibc.bkbits.net 
is no longer the current version, but I'm not sure whether the 
other link is better.


Whom should I CC for other documentation updates? Is the maintainer 
the correct person, or are such small fixes "send and forget"?


Regards,

Phil



diff -ur linux-2.6.21.1-orig/Documentation/early-userspace/buffer-format.txt linux-2.6.21.1/Documentation/early-userspace/buffer-format.txt
--- linux-2.6.21.1-orig/Documentation/early-userspace/buffer-format.txt	2007-04-27 23:49:26.000000000 +0200
+++ linux-2.6.21.1/Documentation/early-userspace/buffer-format.txt	2007-07-30 07:22:24.000000000 +0200
@@ -6,8 +6,8 @@
 
 Starting with kernel 2.5.x, the old "initial ramdisk" protocol is
 getting {replaced/complemented} with the new "initial ramfs"
-(initramfs) protocol.  The initramfs contents is passed using the same
-memory buffer protocol used by the initrd protocol, but the contents
+(initramfs) protocol.  The initramfs is passed using the same
+memory buffer protocol used by the initrd protocol, but the content
 is different.  The initramfs buffer contains an archive which is
 expanded into a ramfs filesystem; this document details the format of
 the initramfs buffer format.
@@ -38,7 +38,7 @@
 
 In human terms, the initramfs buffer contains a collection of
 compressed and/or uncompressed cpio archives (in the "newc" or "crc"
-formats); arbitrary amounts zero bytes (for padding) can be added
+formats); arbitrary amounts of zero bytes (for padding) can be added
 between members.
 
 The cpio "TRAILER!!!" entry (cpio end-of-archive) is optional, but is
diff -ur linux-2.6.21.1-orig/Documentation/early-userspace/README linux-2.6.21.1/Documentation/early-userspace/README
--- linux-2.6.21.1-orig/Documentation/early-userspace/README	2007-04-27 23:49:26.000000000 +0200
+++ linux-2.6.21.1/Documentation/early-userspace/README	2007-07-30 07:18:48.000000000 +0200
@@ -44,7 +44,7 @@
 CONFIG_INITRAMFS_SOURCE.  Sources can be either directories or files -
 cpio archives are *not* allowed when building from sources.
 
-A source directory will have it and all of it's contents packaged.  The
+A source directory will have it and all of its contents packaged.  The
 specified directory name will be mapped to '/'.  When packaging a
 directory, limited user and group ID translation can be performed.
 INITRAMFS_ROOT_UID can be set to a user ID that needs to be mapped to
@@ -56,7 +56,7 @@
 file format).  The directives in the file will be passed directly to
 usr/gen_init_cpio.
 
-When a combination of directories and files are specified then the
+When a combination of directories and files are specified, the
 initramfs image will be an aggregate of all of them.  In this way a user
 can create a 'root-image' directory and install all files into it.
 Because device-special files cannot be created by a unprivileged user,
@@ -71,7 +71,7 @@
 gen_initramfs_list.sh.  If a directory is specified as an argument then
 the contents are scanned, uid/gid translation is performed, and
 usr/gen_init_cpio file directives are output.  If a directory is
-specified as an arugemnt to scripts/gen_initramfs_list.sh then the
+specified as an argument to scripts/gen_initramfs_list.sh the
 contents of the file are simply copied to the output.  All of the output
 directives from directory scanning and file contents copying are
 processed by usr/gen_init_cpio.
@@ -91,6 +91,6 @@
 
-For active users, you are better off using the klibc BitKeeper
-repositories, at http://klibc.bkbits.net/
+For active users, you are better off using the snapshots at
+ftp://ftp.kernel.org/pub/linux/libs/klibc/
 
 The standalone klibc distribution currently provides three components,
 in addition to the klibc library:



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation fixes
  2005-07-06 23:12 Daniel Walker
@ 2005-07-06 23:27 ` randy_dunlap
  0 siblings, 0 replies; 6+ messages in thread
From: randy_dunlap @ 2005-07-06 23:27 UTC (permalink / raw)
  To: dwalker; +Cc: linux-kernel, torvalds, mingo, greg, alan

On Wed, 06 Jul 2005 16:12:11 -0700 Daniel Walker wrote:

| 
| I noticed some typo's or mis-thoughts .. Here are my corrections. I
| tried to CC all the authors.

Yes, mostly good corrections.  Here are more on top of yours.

Thanks,
~Randy


| Index: linux-2.6.12/Documentation/watchdog/watchdog.txt
| ===================================================================
| --- linux-2.6.12.orig/Documentation/watchdog/watchdog.txt	2005-06-17 19:48:29.000000000 +0000
| +++ linux-2.6.12/Documentation/watchdog/watchdog.txt	2005-07-03 18:12:40.000000000 +0000
| @@ -18,12 +18,12 @@ The following watchdog drivers are curre
|  All six interfaces provide /dev/watchdog, which when open must be written
|  to within a timeout or the machine will reboot. Each write delays the reboot
|  time another timeout. In the case of the software watchdog the ability to 
| -reboot will depend on the state of the machines and interrupts. The hardware
| +reboot will depend on the state of the machine and interrupts. The hardware
|  boards physically pull the machine down off their own onboard timers and
|  will reboot from almost anything.
|  
|  A second temperature monitoring interface is available on the WDT501P cards
| -and some Berkshire cards. This provides /dev/temperature. This is the machine 
| +and some Berkshire cards. This provides /dev/temperature. This is the machines 
                                                                         machine's
  (and kill the trailing space)

|  internal temperature in degrees Fahrenheit. Each read returns a single byte 
|  giving the temperature.
|  
| @@ -37,16 +37,16 @@ The wdt card cannot be safely probed for
|  wdt=ioaddr,irq as a boot parameter - eg "wdt=0x240,11".
|  
|  The SA1100 watchdog module can be configured with the "sa1100_margin"
| -commandline argument which specifies timeout value in seconds.
| +commandline argument which specifies the timeout value in seconds.
|  
|  The i810 TCO watchdog modules can be configured with the "i810_margin"
| -commandline argument which specifies the counter initial value. The counter
| -is decremented every 0.6 seconds and default to 50 (30 seconds). Values can
| +commandline argument which specifies the counters initial value. The counter
                                            counter's
| +is decremented every 0.6 seconds and defaults to 50 (30 seconds). Values can
|  range between 3 and 63.
|  
|  The i810 TCO watchdog driver also implements the WDIOC_GETSTATUS and
|  WDIOC_GETBOOTSTATUS ioctl()s. WDIOC_GETSTATUS returns the actual counter value
| -and WDIOC_GETBOOTSTATUS returns the value of TCO2 Status Register (see Intel's
| +and WDIOC_GETBOOTSTATUS returns the value of the TCO2 Status Register (see Intel's

Please wrap lines at < 80 characters per line.

|  documentation for the 82801AA and 82801AB datasheet). 

^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH] Documentation fixes
@ 2005-07-06 23:12 Daniel Walker
  2005-07-06 23:27 ` randy_dunlap
  0 siblings, 1 reply; 6+ messages in thread
From: Daniel Walker @ 2005-07-06 23:12 UTC (permalink / raw)
  To: linux-kernel; +Cc: torvalds, mingo, greg, alan


I noticed some typo's or mis-thoughts .. Here are my corrections. I
tried to CC all the authors.

Daniel

Signed-Off-By: Daniel Walker <dwalker@mvista.com> 

Index: linux-2.6.12/Documentation/ManagementStyle
===================================================================
--- linux-2.6.12.orig/Documentation/ManagementStyle	2005-06-17 19:48:29.000000000 +0000
+++ linux-2.6.12/Documentation/ManagementStyle	2005-07-03 18:55:03.000000000 +0000
@@ -20,9 +20,9 @@ These suggestions may or may not apply t
 First off, I'd suggest buying "Seven Habits of Highly Successful
 People", and NOT read it.  Burn it, it's a great symbolic gesture. 
 
-(*) This document does so not so much by answering the question, but by
-making it painfully obvious to the questioner that we don't have a clue
-to what the answer is. 
+(*) This document doesn't do much to answer the questions, but makes 
+it painfully obvious to the questioner that we don't have a clue as to 
+what the answers are. 
 
 Anyway, here goes:
 
@@ -47,7 +47,7 @@ Namely that you are in the wrong job, an
 your brilliance instead). 
 
 So the name of the game is to _avoid_ decisions, at least the big and
-painful ones.  Making small and non-consequential decisions is fine, and
+painful ones.  Making small and inconsequential decisions is fine, and
 makes you look like you know what you're doing, so what a kernel manager
 needs to do is to turn the big and painful ones into small things where
 nobody really cares. 
@@ -72,7 +72,7 @@ a kernel manager have huge fiscal respon
 fairly easy to backtrack.  Since you're not going to be able to waste
 huge amounts of money that you might not be able to repay, the only
 thing you can backtrack on is a technical decision, and there
-back-tracking is very easy: just tell everybody that you were an
+backtracking is very easy: just tell everybody that you were an
 incompetent nincompoop, say you're sorry, and undo all the worthless
 work you had people work on for the last year.  Suddenly the decision
 you made a year ago wasn't a big decision after all, since it could be
@@ -166,7 +166,7 @@ To solve this problem, you really only h
 The option of being unfailingly polite really doesn't exist. Nobody will
 trust somebody who is so clearly hiding his true character.
 
-(*) Paul Simon sang "Fifty Ways to Lose Your Lover", because quite
+(*) Paul Simon sang "Fifty Ways to Leave Your Lover", because quite
 frankly, "A Million Ways to Tell a Developer He Is a D*ckhead" doesn't
 scan nearly as well.  But I'm sure he thought about it. 
 
@@ -178,7 +178,7 @@ sadly that you are one too, and that whi
 knowledge that we're better than the average person (let's face it,
 nobody ever believes that they're average or below-average), we should
 also admit that we're not the sharpest knife around, and there will be
-other people that are less of an idiot that you are. 
+other people that are less of an idiot than you are. 
 
 Some people react badly to smart people.  Others take advantage of them. 
 
@@ -262,7 +262,7 @@ a while, and you'll feel cleansed. Just 
 		Chapter 6: Why me?
 
 Since your main responsibility seems to be to take the blame for other
-peoples mistakes, and make it painfully obvious to everybody else that
+peoples' mistakes, and make it painfully obvious to everybody else that
 you're incompetent, the obvious question becomes one of why do it in the
 first place?
 
Index: linux-2.6.12/Documentation/nmi_watchdog.txt
===================================================================
--- linux-2.6.12.orig/Documentation/nmi_watchdog.txt	2005-06-17 19:48:29.000000000 +0000
+++ linux-2.6.12/Documentation/nmi_watchdog.txt	2005-07-03 18:21:28.000000000 +0000
@@ -2,7 +2,7 @@
 [NMI watchdog is available for x86 and x86-64 architectures]
 
 Is your system locking up unpredictably? No keyboard activity, just
-a frustrating complete hard lockup? Do you want to help us debugging
+a frustrating complete hard lockup? Do you want to help us in debugging
 such lockups? If all yes then this document is definitely for you.
 
 On many x86/x86-64 type hardware there is a feature that enables
@@ -73,7 +73,7 @@ you have to enable it with a boot time p
 the NMI-oopser is enabled unconditionally on x86 SMP boxes.
 
 On x86-64 the NMI oopser is on by default. On 64bit Intel CPUs
-it uses IO-APIC by default and on AMD it uses local APIC.
+it uses the IO-APIC by default and on AMD it uses the local APIC.
 
 [ feel free to send bug reports, suggestions and patches to
   Ingo Molnar <mingo@redhat.com> or the Linux SMP mailing
Index: linux-2.6.12/Documentation/stable_api_nonsense.txt
===================================================================
--- linux-2.6.12.orig/Documentation/stable_api_nonsense.txt	2005-06-17 19:48:29.000000000 +0000
+++ linux-2.6.12/Documentation/stable_api_nonsense.txt	2005-07-03 18:04:41.000000000 +0000
@@ -132,7 +132,7 @@ to extra work for the USB developers.  S
 their work on their own time, asking programmers to do extra work for no
 gain, for free, is not a possibility.
 
-Security issues are also a very important for Linux.  When a
+Security issues are also very important for Linux.  When a
 security issue is found, it is fixed in a very short amount of time.  A
 number of times this has caused internal kernel interfaces to be
 reworked to prevent the security problem from occurring.  When this
Index: linux-2.6.12/Documentation/watchdog/watchdog.txt
===================================================================
--- linux-2.6.12.orig/Documentation/watchdog/watchdog.txt	2005-06-17 19:48:29.000000000 +0000
+++ linux-2.6.12/Documentation/watchdog/watchdog.txt	2005-07-03 18:12:40.000000000 +0000
@@ -18,12 +18,12 @@ The following watchdog drivers are curre
 All six interfaces provide /dev/watchdog, which when open must be written
 to within a timeout or the machine will reboot. Each write delays the reboot
 time another timeout. In the case of the software watchdog the ability to 
-reboot will depend on the state of the machines and interrupts. The hardware
+reboot will depend on the state of the machine and interrupts. The hardware
 boards physically pull the machine down off their own onboard timers and
 will reboot from almost anything.
 
 A second temperature monitoring interface is available on the WDT501P cards
-and some Berkshire cards. This provides /dev/temperature. This is the machine 
+and some Berkshire cards. This provides /dev/temperature. This is the machines 
 internal temperature in degrees Fahrenheit. Each read returns a single byte 
 giving the temperature.
 
@@ -37,16 +37,16 @@ The wdt card cannot be safely probed for
 wdt=ioaddr,irq as a boot parameter - eg "wdt=0x240,11".
 
 The SA1100 watchdog module can be configured with the "sa1100_margin"
-commandline argument which specifies timeout value in seconds.
+commandline argument which specifies the timeout value in seconds.
 
 The i810 TCO watchdog modules can be configured with the "i810_margin"
-commandline argument which specifies the counter initial value. The counter
-is decremented every 0.6 seconds and default to 50 (30 seconds). Values can
+commandline argument which specifies the counters initial value. The counter
+is decremented every 0.6 seconds and defaults to 50 (30 seconds). Values can
 range between 3 and 63.
 
 The i810 TCO watchdog driver also implements the WDIOC_GETSTATUS and
 WDIOC_GETBOOTSTATUS ioctl()s. WDIOC_GETSTATUS returns the actual counter value
-and WDIOC_GETBOOTSTATUS returns the value of TCO2 Status Register (see Intel's
+and WDIOC_GETBOOTSTATUS returns the value of the TCO2 Status Register (see Intel's
 documentation for the 82801AA and 82801AB datasheet). 
 
 Features



^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2007-08-01  5:55 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2004-12-23 23:09 [PATCH] Documentation fixes Martin Waitz
2005-07-06 23:12 Daniel Walker
2005-07-06 23:27 ` randy_dunlap
2007-07-31  9:14 [PATCH] documentation fixes Ph. Marek
2007-07-31 20:14 ` Cal Peake
2007-08-01  5:55   ` Ph. Marek

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).