[PATCH] kernel/acct: add kerneldoc

for kernel/acct.c: - fix typos - add kerneldoc for non-static functions Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>

[PATCH] kernel/acct: add kerneldoc
for kernel/acct.c: - fix typos - add kerneldoc for non-static functions Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Randy Dunlap · Linus Torvalds
1 parent 621a4d1a82
Showing 1 changed file with 27 additions and 16 deletions Side-by-side Diff
kernel/acct.c
@@ -165,7 +165,7 @@
 }
  
 /*
- * Close the old accouting file (if currently open) and then replace
+ * Close the old accounting file (if currently open) and then replace
  * it with file (if non-NULL).
  *
  * NOTE: acct_globals.lock MUST be held on entry and exit.
@@ -199,11 +199,16 @@
 	}
 }
  
-/*
- *  sys_acct() is the only system call needed to implement process
- *  accounting. It takes the name of the file where accounting records
- *  should be written. If the filename is NULL, accounting will be
- *  shutdown.
+/**
+ * sys_acct - enable/disable process accounting
+ * @name: file name for accounting records or NULL to shutdown accounting
+ *
+ * Returns 0 for success or negative errno values for failure.
+ *
+ * sys_acct() is the only system call needed to implement process
+ * accounting. It takes the name of the file where accounting records
+ * should be written. If the filename is NULL, accounting will be
+ * shutdown.
  */
 asmlinkage long sys_acct(const char __user *name)
 {
@@ -250,9 +255,12 @@
 	return (0);
 }
  
-/*
- * If the accouting is turned on for a file in the filesystem pointed
- * to by sb, turn accouting off.
+/**
+ * acct_auto_close - turn off a filesystem's accounting if it is on
+ * @sb: super block for the filesystem
+ *
+ * If the accounting is turned on for a file in the filesystem pointed
+ * to by sb, turn accounting off.
  */
 void acct_auto_close(struct super_block *sb)
 {
  
@@ -503,8 +511,11 @@
 	set_fs(fs);
 }
  
-/*
+/**
  * acct_process - now just a wrapper around do_acct_process
+ * @exitcode: task exit code
+ *
+ * handles process accounting for an exiting task
  */
 void acct_process(long exitcode)
 {
@@ -530,9 +541,9 @@
 }
  
  
-/*
- * acct_update_integrals
- *    -  update mm integral fields in task_struct
+/**
+ * acct_update_integrals - update mm integral fields in task_struct
+ * @tsk: task_struct for accounting
  */
 void acct_update_integrals(struct task_struct *tsk)
 {
@@ -547,9 +558,9 @@
 	}
 }
  
-/*
- * acct_clear_integrals
- *    - clear the mm integral fields in task_struct
+/**
+ * acct_clear_integrals - clear the mm integral fields in task_struct
+ * @tsk: task_struct whose accounting fields are cleared
  */
 void acct_clear_integrals(struct task_struct *tsk)
 {
...	...	@@ -165,7 +165,7 @@
165	165	}
166	166
167	167	/*
168		- * Close the old accouting file (if currently open) and then replace
	168	+ * Close the old accounting file (if currently open) and then replace
169	169	* it with file (if non-NULL).
170	170	*
171	171	* NOTE: acct_globals.lock MUST be held on entry and exit.
...	...	@@ -199,11 +199,16 @@
199	199	}
200	200	}
201	201
202		-/*
203		- * sys_acct() is the only system call needed to implement process
204		- * accounting. It takes the name of the file where accounting records
205		- * should be written. If the filename is NULL, accounting will be
206		- * shutdown.
	202	+/**
	203	+ * sys_acct - enable/disable process accounting
	204	+ * @name: file name for accounting records or NULL to shutdown accounting
	205	+ *
	206	+ * Returns 0 for success or negative errno values for failure.
	207	+ *
	208	+ * sys_acct() is the only system call needed to implement process
	209	+ * accounting. It takes the name of the file where accounting records
	210	+ * should be written. If the filename is NULL, accounting will be
	211	+ * shutdown.
207	212	*/
208	213	asmlinkage long sys_acct(const char __user *name)
209	214	{
...	...	@@ -250,9 +255,12 @@
250	255	return (0);
251	256	}
252	257
253		-/*
254		- * If the accouting is turned on for a file in the filesystem pointed
255		- * to by sb, turn accouting off.
	258	+/**
	259	+ * acct_auto_close - turn off a filesystem's accounting if it is on
	260	+ * @sb: super block for the filesystem
	261	+ *
	262	+ * If the accounting is turned on for a file in the filesystem pointed
	263	+ * to by sb, turn accounting off.
256	264	*/
257	265	void acct_auto_close(struct super_block *sb)
258	266	{
259	267
...	...	@@ -503,8 +511,11 @@
503	511	set_fs(fs);
504	512	}
505	513
506		-/*
	514	+/**
507	515	* acct_process - now just a wrapper around do_acct_process
	516	+ * @exitcode: task exit code
	517	+ *
	518	+ * handles process accounting for an exiting task
508	519	*/
509	520	void acct_process(long exitcode)
510	521	{
...	...	@@ -530,9 +541,9 @@
530	541	}
531	542
532	543
533		-/*
534		- * acct_update_integrals
535		- * - update mm integral fields in task_struct
	544	+/**
	545	+ * acct_update_integrals - update mm integral fields in task_struct
	546	+ * @tsk: task_struct for accounting
536	547	*/
537	548	void acct_update_integrals(struct task_struct *tsk)
538	549	{
...	...	@@ -547,9 +558,9 @@
547	558	}
548	559	}
549	560
550		-/*
551		- * acct_clear_integrals
552		- * - clear the mm integral fields in task_struct
	561	+/**
	562	+ * acct_clear_integrals - clear the mm integral fields in task_struct
	563	+ * @tsk: task_struct whose accounting fields are cleared
553	564	*/
554	565	void acct_clear_integrals(struct task_struct *tsk)
555	566	{