Commit 6c8bec6d authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

[PATCH] jbd doc: fix some kernel-doc warnings 



Add structure fields kernel-doc for 2 fields in struct journal_s.

Warning(/var/linsrc/linux-2614-rc4//include/linux/jbd.h:808): No description found for parameter 'j_wbuf'
Warning(/var/linsrc/linux-2614-rc4//include/linux/jbd.h:808): No description found for parameter 'j_wbufsize'

Convert fs/jbd/recovery.c non-static functions to kernel-doc format.

fs/jbd/recovery.c doesn't export any symbols, so it should use
!I instead of !E to eliminate this warning message:

Warning(/var/linsrc/linux-2614-rc4//fs/jbd/recovery.c): no structured comments found

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 2500e7ab

Documentation/DocBook/journal-api.tmpl

+1 −1
Original line number Diff line number Diff line
@@ -306,7 +306,7 @@ an example. 
</para>

	<sect1><title>Journal Level</title>

!Efs/jbd/journal.c

!Efs/jbd/recovery.c

!Ifs/jbd/recovery.c

	</sect1>

	<sect1><title>Transasction Level</title>

!Efs/jbd/transaction.c

fs/jbd/recovery.c

+2 −2
Original line number Diff line number Diff line
@@ -210,7 +210,7 @@ do { \ 
} while (0)



/**

 * int journal_recover(journal_t *journal) - recovers a on-disk journal

 * journal_recover - recovers a on-disk journal

 * @journal: the journal to recover

 * 

 * The primary function for recovering the log contents when mounting a
@@ -266,7 +266,7 @@ int journal_recover(journal_t *journal) 
}



/**

 * int journal_skip_recovery() - Start journal and wipe exiting records 

 * journal_skip_recovery - Start journal and wipe exiting records

 * @journal: journal to startup

 * 

 * Locate any valid recovery information from the journal and set up the

include/linux/jbd.h

+3 −0
Original line number Diff line number Diff line
@@ -611,6 +611,9 @@ struct transaction_s 
 * @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_wbuf: array of buffer_heads for journal_commit_transaction

 * @j_wbufsize: maximum number of buffer_heads allowed in j_wbuf, the

 *	number that will fit in j_blocksize

 * @j_private: An opaque pointer to fs-private information.

 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE