Skip to contentSkip to conversation

fix up kerneldoc in fs/ioctl.c a little bit

PATCH In review Christoph Hellwig 2 participants 3 messages Feb 9, 2008

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

PATCH 1/1 fix up kerneldoc in fs/ioctl.c a little bit

- remove non-standard in/out markers
- use tabs for formatting

fs/ioctl.c +3 -3
Index: linux-2.6/fs/ioctl.c
===================================================================
@@ -18,9 +18,9 @@
 
 /**
  * vfs_ioctl - call filesystem specific ioctl methods
- * @filp: [in]     open file to invoke ioctl method on
- * @cmd:  [in]     ioctl command to execute
- * @arg:  [in/out] command-specific argument for ioctl
+ * @filp:	open file to invoke ioctl method on
+ * @cmd:	ioctl command to execute
+ * @arg:	command-specific argument for ioctl
  *
  * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
  * invokes * filesystem specific ->ioctl method.  If neither method exists,
#1 lore raw
Quoted 13 lines · Christoph Hellwig

- remove non-standard in/out markers
- use tabs for formatting

Index: linux-2.6/fs/ioctl.c
===================================================================

fs/ioctl.c +0 -0
@@ -18,9 +18,9 @@
 
 /**

fs/ioctl.c line 26

Quoted 10 lines
fs/ioctl.c +3 -3
  * vfs_ioctl - call filesystem specific ioctl methods
- * @filp: [in]     open file to invoke ioctl method on
- * @cmd:  [in]     ioctl command to execute
- * @arg:  [in/out] command-specific argument for ioctl
+ * @filp:	open file to invoke ioctl method on
+ * @cmd:	ioctl command to execute
+ * @arg:	command-specific argument for ioctl
  *
  * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
  * invokes * filesystem specific ->ioctl method.  If neither method exists,
              ^

I also think this extra '*' in the last comment line above is spurious, perhaps the result of a paragraph reformatting command that mixed comment *'s with text.

Erez.

#2 lore raw
Quoted 7 lines · Erez Zadok
Quoted 2 lines

* Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
* invokes * filesystem specific ->ioctl method. If neither method exists,

              ^

I also think this extra '*' in the last comment line above is spurious, perhaps the result of a paragraph reformatting command that mixed comment *'s with text.

Indeed. Updated patch below:

fs/ioctl.c +4 -4
Index: linux-2.6/fs/ioctl.c
===================================================================
@@ -18,12 +18,12 @@
 
 /**
  * vfs_ioctl - call filesystem specific ioctl methods
- * @filp: [in]     open file to invoke ioctl method on
- * @cmd:  [in]     ioctl command to execute
- * @arg:  [in/out] command-specific argument for ioctl
+ * @filp:	open file to invoke ioctl method on
+ * @cmd:	ioctl command to execute
+ * @arg:	command-specific argument for ioctl
  *
  * Invokes filesystem specific ->unlocked_ioctl, if one exists; otherwise
- * invokes * filesystem specific ->ioctl method.  If neither method exists,
+ * invokes filesystem specific ->ioctl method.  If neither method exists,
  * returns -ENOTTY.
  *
  * Returns 0 on success, -errno on error.