diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2005-11-07 04:01:04 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2005-11-07 10:53:55 -0500 |
commit | 6c8bec6d5f24b01c53b792b06a645e78d482020d (patch) | |
tree | d394d7d77087c02f84f84a27d3e9933d9c096bed | |
parent | 2500e7abc8f606d87b2590f205dac080640b6b04 (diff) |
[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: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
-rw-r--r-- | Documentation/DocBook/journal-api.tmpl | 2 | ||||
-rw-r--r-- | fs/jbd/recovery.c | 4 | ||||
-rw-r--r-- | include/linux/jbd.h | 3 |
3 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/DocBook/journal-api.tmpl b/Documentation/DocBook/journal-api.tmpl index 341aaa4ce481..2077f9a28c19 100644 --- a/Documentation/DocBook/journal-api.tmpl +++ b/Documentation/DocBook/journal-api.tmpl | |||
@@ -306,7 +306,7 @@ an example. | |||
306 | </para> | 306 | </para> |
307 | <sect1><title>Journal Level</title> | 307 | <sect1><title>Journal Level</title> |
308 | !Efs/jbd/journal.c | 308 | !Efs/jbd/journal.c |
309 | !Efs/jbd/recovery.c | 309 | !Ifs/jbd/recovery.c |
310 | </sect1> | 310 | </sect1> |
311 | <sect1><title>Transasction Level</title> | 311 | <sect1><title>Transasction Level</title> |
312 | !Efs/jbd/transaction.c | 312 | !Efs/jbd/transaction.c |
diff --git a/fs/jbd/recovery.c b/fs/jbd/recovery.c index 103c34e4fb28..80d7f53fd0a7 100644 --- a/fs/jbd/recovery.c +++ b/fs/jbd/recovery.c | |||
@@ -210,7 +210,7 @@ do { \ | |||
210 | } while (0) | 210 | } while (0) |
211 | 211 | ||
212 | /** | 212 | /** |
213 | * int journal_recover(journal_t *journal) - recovers a on-disk journal | 213 | * journal_recover - recovers a on-disk journal |
214 | * @journal: the journal to recover | 214 | * @journal: the journal to recover |
215 | * | 215 | * |
216 | * The primary function for recovering the log contents when mounting a | 216 | * The primary function for recovering the log contents when mounting a |
@@ -266,7 +266,7 @@ int journal_recover(journal_t *journal) | |||
266 | } | 266 | } |
267 | 267 | ||
268 | /** | 268 | /** |
269 | * int journal_skip_recovery() - Start journal and wipe exiting records | 269 | * journal_skip_recovery - Start journal and wipe exiting records |
270 | * @journal: journal to startup | 270 | * @journal: journal to startup |
271 | * | 271 | * |
272 | * Locate any valid recovery information from the journal and set up the | 272 | * Locate any valid recovery information from the journal and set up the |
diff --git a/include/linux/jbd.h b/include/linux/jbd.h index be197eb90077..aa56172c6fed 100644 --- a/include/linux/jbd.h +++ b/include/linux/jbd.h | |||
@@ -611,6 +611,9 @@ struct transaction_s | |||
611 | * @j_revoke: The revoke table - maintains the list of revoked blocks in the | 611 | * @j_revoke: The revoke table - maintains the list of revoked blocks in the |
612 | * current transaction. | 612 | * current transaction. |
613 | * @j_revoke_table: alternate revoke tables for j_revoke | 613 | * @j_revoke_table: alternate revoke tables for j_revoke |
614 | * @j_wbuf: array of buffer_heads for journal_commit_transaction | ||
615 | * @j_wbufsize: maximum number of buffer_heads allowed in j_wbuf, the | ||
616 | * number that will fit in j_blocksize | ||
614 | * @j_private: An opaque pointer to fs-private information. | 617 | * @j_private: An opaque pointer to fs-private information. |
615 | */ | 618 | */ |
616 | 619 | ||