fs: fix kernel-doc notation warnings
Subsystems (2)
PATCH 1/1 fs: fix kernel-doc notation warnings
From: Randy Dunlap <[email protected]>
Fix kernel-doc notation warnings in fs/.
Warning(mmotm-2008-0314-1449//fs/super.c:560): missing initial short description on line:
* mark_files_ro
Warning(mmotm-2008-0314-1449//fs/locks.c:1277): missing initial short description on line:
* lease_get_mtime
Warning(mmotm-2008-0314-1449//fs/locks.c:1277): missing initial short description on line:
* lease_get_mtime
Warning(mmotm-2008-0314-1449//fs/namei.c:1368): missing initial short description on line:
* lookup_one_len: filesystem helper to lookup single pathname component
Warning(mmotm-2008-0314-1449//fs/buffer.c:3221): missing initial short description on line:
* bh_uptodate_or_lock: Test whether the buffer is uptodate
Warning(mmotm-2008-0314-1449//fs/buffer.c:3240): missing initial short description on line:
* bh_submit_read: Submit a locked buffer for reading
Warning(mmotm-2008-0314-1449//fs/fs-writeback.c:30): missing initial short description on line:
* writeback_acquire: attempt to get exclusive writeback access to a device
Warning(mmotm-2008-0314-1449//fs/fs-writeback.c:47): missing initial short description on line:
* writeback_in_progress: determine whether there is writeback in progress
Warning(mmotm-2008-0314-1449//fs/fs-writeback.c:58): missing initial short description on line:
* writeback_release: relinquish exclusive writeback access against a device.
Warning(mmotm-2008-0314-1449//include/linux/jbd.h:351): contents before sections Warning(mmotm-2008-0314-1449//include/linux/jbd.h:561): contents before sections Warning(mmotm-2008-0314-1449//fs/jbd/transaction.c:1935): missing initial short description on line:
* void journal_invalidatepage()
--- fs/buffer.c | 4 ++-- fs/fs-writeback.c | 6 +++--- fs/jbd/transaction.c | 5 ++--- fs/locks.c | 4 ++-- fs/namei.c | 6 +++--- fs/super.c | 6 +++--- include/linux/jbd.h | 11 ++--------- 7 files changed, 17 insertions(+), 25 deletions(-)
fs/locks.c +2 -2
@@ -1274,13 +1274,13 @@ out:EXPORT_SYMBOL (__break_lease);/** -* lease_get_mtime +* lease_get_mtime - get the last modified time of an inode * @inode: the inode * @time: pointer to a timespec which will contain the last modified time * * This is to force NFS clients to flush their caches for files with * exclusive leases. The justification is that if someone has an -* exclusive lease, then they could be modifiying it. +* exclusive lease, then they could be modifying it. */ void lease_get_mtime (struct inode *inode,struct timespec *time) {
fs/namei.c +3 -3
@@ -1365,13 +1365,13 @@ static int __lookup_one_len(const char * }/** -* lookup_one_len: filesystem helper to lookup single pathname component +* lookup_one_len - filesystem helper to lookup single pathname component * @name: pathname component to lookup * @base: base directory to lookup from * @len: maximum length @len should be interpreted to * -* Note that this routine is purely a helper for filesystem useage and should -* not be called by generic code. Also note that by using this function to +* Note that this routine is purely a helper for filesystem usage and should +* not be called by generic code. Also note that by using this function the * nameidata argument is passed to the filesystem methods and a filesystem * using this helper needs to be prepared for that. */
fs/super.c +3 -3
@@ -557,11 +557,11 @@ out: }/** -* mark_files_ro +* mark_files_ro - mark all files read-only * @sb: superblock in question * -* All files are marked read/only. We don't care about pending -* delete files so this should be used in 'force' mode only +* All files are marked read-only. We don't care about pending +* delete files so this should be used in 'force' mode only. */ static void mark_files_ro (struct super_block *sb)
fs/buffer.c +2 -2
@@ -3218,7 +3218,7 @@ static int buffer_cpu_notify(struct noti }/** -* bh_uptodate_or_lock: Test whether the buffer is uptodate +* bh_uptodate_or_lock - Test whether the buffer is uptodate * @bh: struct buffer_head * * Return true if the buffer is up-to-date and false,
@@ -3237,7 +3237,7 @@ int bh_uptodate_or_lock(struct buffer_heEXPORT_SYMBOL (bh_uptodate_or_lock);/** -* bh_submit_read: Submit a locked buffer for reading +* bh_submit_read - Submit a locked buffer for reading * @bh: struct buffer_head * * Returns zero on success and -EIO on error.
fs/fs-writeback.c +3 -3
@@ -27,7 +27,7 @@/** -* writeback_acquire: attempt to get exclusive writeback access to a device +* writeback_acquire - attempt to get exclusive writeback access to a device * @bdi: the device's backing_dev_info structure * * It is a waste of resources to have more than one pdflush thread blocked on
@@ -44,7 +44,7 @@ static int writeback_acquire(struct back }/** -* writeback_in_progress: determine whether there is writeback in progress +* writeback_in_progress - determine whether there is writeback in progress * @bdi: the device's backing_dev_info structure. * * Determine whether there is writeback in progress against a backing device.
@@ -55,7 +55,7 @@ int writeback_in_progress(struct backing }/** -* writeback_release: relinquish exclusive writeback access against a device. +* writeback_release - relinquish exclusive writeback access against a device. * @bdi: the device's backing_dev_info structure */ static void writeback_release (struct backing_dev_info *bdi)
include/linux/jbd.h +2 -9
@@ -346,8 +346,7 @@ static inline void jbd_unlock_bh_journalstruct jbd_revoke_table_s ;/** -* struct handle_s - The handle_s type is the concrete type associated with -* handle_t. +* struct handle_s - this is the concrete type associated with handle_t. * @h_transaction: Which compound transaction is this update a part of? * @h_buffer_credits: Number of remaining buffers we are allowed to dirty. * @h_ref: Reference count on this handle
@@ -356,12 +355,7 @@ struct jbd_revoke_table_s;* @h_jdata: flag to force data journaling * @h_aborted: flag indicating fatal error on handle * @h_lockdep_map: lockdep info for debugging lock problems -**/ - -/* Docbook can't yet cope with the bit fields, but will leave the documentation -* in so it can be fixed later. */ -struct handle_s {/* Which compound transaction is this update a part of? */
@@ -556,8 +550,7 @@ struct transaction_s };/** -* struct journal_s - The journal_s type is the concrete type associated with -* journal_t. +* struct journal_s - this is the concrete type associated with journal_t. * @j_flags: General journaling state flags * @j_errno: Is there an outstanding uncleared error on the journal (from a * prior abort)?
fs/jbd/transaction.c +2 -3
@@ -1932,13 +1932,12 @@ zap_buffer_unlocked: }/** -* void journal_invalidatepage() -* @journal: journal to use for flush... +* void journal_invalidatepage() - invalidate a journal page +* @journal: journal to use for flush * @page: page to flush * @offset: length of page to invalidate. * * Reap page buffers containing data after offset in page. -* */ void journal_invalidatepage(journal_t *journal, struct page *page,