fs: fix kernel-doc notation warnings
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() Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>hifive-unleashed-5.1
Randy Dunlap
Linus Torvalds
parent
5366dc9fd1
commit
a6b91919e0
|
|
@ -3213,7 +3213,7 @@ static int buffer_cpu_notify(struct notifier_block *self,
|
|||
}
|
||||
|
||||
/**
|
||||
* 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,
|
||||
|
|
@ -3232,7 +3232,7 @@ int bh_uptodate_or_lock(struct buffer_head *bh)
|
|||
EXPORT_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.
|
||||
|
|
|
|||
|
|
@ -751,7 +751,7 @@ int generic_osync_inode(struct inode *inode, struct address_space *mapping, int
|
|||
EXPORT_SYMBOL(generic_osync_inode);
|
||||
|
||||
/**
|
||||
* 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
|
||||
|
|
@ -768,7 +768,7 @@ int writeback_acquire(struct backing_dev_info *bdi)
|
|||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
|
|
@ -779,7 +779,7 @@ int writeback_in_progress(struct backing_dev_info *bdi)
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
void writeback_release(struct backing_dev_info *bdi)
|
||||
|
|
|
|||
|
|
@ -1904,13 +1904,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,
|
||||
|
|
|
|||
|
|
@ -1275,13 +1275,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)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1364,13 +1364,13 @@ static int __lookup_one_len(const char *name, struct qstr *this,
|
|||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -556,11 +556,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)
|
||||
|
|
|
|||
|
|
@ -348,8 +348,7 @@ static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh)
|
|||
struct 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
|
||||
|
|
@ -358,12 +357,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? */
|
||||
|
|
@ -558,8 +552,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)?
|
||||
|
|
|
|||
Loading…
Reference in New Issue