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

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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 5366dc9f

fs/buffer.c

+2 −2
Original line number Diff line number Diff line
@@ -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.

fs/fs-writeback.c

+3 −3
Original line number Diff line number Diff line
@@ -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)

fs/jbd/transaction.c

+2 −3
Original line number Diff line number Diff line
@@ -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,

fs/locks.c

+2 −2
Original line number Diff line number Diff line
@@ -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)

{

fs/namei.c

+3 −3
Original line number Diff line number Diff line
@@ -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.

 */

CRA Git | Maintained and supported by SUSTech CRA and CCSE