Commit 2bf31d94 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Theodore Ts'o
Browse files

jbd2: fix kernel-doc markups 



Kernel-doc markup should use this format:
        identifier - description

They should not have any type before that, as otherwise
the parser won't do the right thing.

Also, some identifiers have different names between their
prototypes and the kernel-doc markup.

Reviewed-by: default avatarJan Kara <jack@suse.cz>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/72f5c6628f5f278d67625f60893ffbc2ca28d46e.1605521731.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarTheodore Ts'o <tytso@mit.edu>
parent 704c2317

fs/jbd2/journal.c

+18 −16
Original line number Diff line number Diff line
@@ -566,12 +566,14 @@ static int __jbd2_journal_force_commit(journal_t *journal) 
}



/**

 * Force and wait upon a commit if the calling process is not within

 * transaction.  This is used for forcing out undo-protected data which contains

 * bitmaps, when the fs is running out of space.

 * jbd2_journal_force_commit_nested - Force and wait upon a commit if the

 * calling process is not within transaction.

 *

 * @journal: journal to force

 * Returns true if progress was made.

 *

 * This is used for forcing out undo-protected data which contains

 * bitmaps, when the fs is running out of space.

 */

int jbd2_journal_force_commit_nested(journal_t *journal)

{
@@ -582,7 +584,7 @@ int jbd2_journal_force_commit_nested(journal_t *journal) 
}



/**

 * int journal_force_commit() - force any uncommitted transactions

 * jbd2_journal_force_commit() - force any uncommitted transactions

 * @journal: journal to force

 *

 * Caller want unconditional commit. We can only force the running transaction
@@ -1881,7 +1883,7 @@ static int load_superblock(journal_t *journal) 




/**

 * int jbd2_journal_load() - Read journal from disk.

 * jbd2_journal_load() - Read journal from disk.

 * @journal: Journal to act on.

 *

 * Given a journal_t structure which tells us which disk blocks contain
@@ -1951,7 +1953,7 @@ recovery_error: 
}



/**

 * void jbd2_journal_destroy() - Release a journal_t structure.

 * jbd2_journal_destroy() - Release a journal_t structure.

 * @journal: Journal to act on.

 *

 * Release a journal_t structure once it is no longer in use by the
@@ -2028,7 +2030,7 @@ int jbd2_journal_destroy(journal_t *journal) 




/**

 *int jbd2_journal_check_used_features() - Check if features specified are used.

 * jbd2_journal_check_used_features() - Check if features specified are used.

 * @journal: Journal to check.

 * @compat: bitmask of compatible features

 * @ro: bitmask of features that force read-only mount
@@ -2063,7 +2065,7 @@ int jbd2_journal_check_used_features(journal_t *journal, unsigned long compat, 
}



/**

 * int jbd2_journal_check_available_features() - Check feature set in journalling layer

 * jbd2_journal_check_available_features() - Check feature set in journalling layer

 * @journal: Journal to check.

 * @compat: bitmask of compatible features

 * @ro: bitmask of features that force read-only mount
@@ -2126,7 +2128,7 @@ jbd2_journal_initialize_fast_commit(journal_t *journal) 
}



/**

 * int jbd2_journal_set_features() - Mark a given journal feature in the superblock

 * jbd2_journal_set_features() - Mark a given journal feature in the superblock

 * @journal: Journal to act on.

 * @compat: bitmask of compatible features

 * @ro: bitmask of features that force read-only mount
@@ -2246,7 +2248,7 @@ void jbd2_journal_clear_features(journal_t *journal, unsigned long compat, 
EXPORT_SYMBOL(jbd2_journal_clear_features);



/**

 * int jbd2_journal_flush () - Flush journal

 * jbd2_journal_flush() - Flush journal

 * @journal: Journal to act on.

 *

 * Flush all data for a given journal to disk and empty the journal.
@@ -2321,7 +2323,7 @@ out: 
}



/**

 * int jbd2_journal_wipe() - Wipe journal contents

 * jbd2_journal_wipe() - Wipe journal contents

 * @journal: Journal to act on.

 * @write: flag (see below)

 *
@@ -2362,7 +2364,7 @@ int jbd2_journal_wipe(journal_t *journal, int write) 
}



/**

 * void jbd2_journal_abort () - Shutdown the journal immediately.

 * jbd2_journal_abort () - Shutdown the journal immediately.

 * @journal: the journal to shutdown.

 * @errno:   an error number to record in the journal indicating

 *           the reason for the shutdown.
@@ -2453,7 +2455,7 @@ void jbd2_journal_abort(journal_t *journal, int errno) 
}



/**

 * int jbd2_journal_errno () - returns the journal's error state.

 * jbd2_journal_errno() - returns the journal's error state.

 * @journal: journal to examine.

 *

 * This is the errno number set with jbd2_journal_abort(), the last
@@ -2477,7 +2479,7 @@ int jbd2_journal_errno(journal_t *journal) 
}



/**

 * int jbd2_journal_clear_err () - clears the journal's error state

 * jbd2_journal_clear_err() - clears the journal's error state

 * @journal: journal to act on.

 *

 * An error must be cleared or acked to take a FS out of readonly
@@ -2497,7 +2499,7 @@ int jbd2_journal_clear_err(journal_t *journal) 
}



/**

 * void jbd2_journal_ack_err() - Ack journal err.

 * jbd2_journal_ack_err() - Ack journal err.

 * @journal: journal to act on.

 *

 * An error must be cleared or acked to take a FS out of readonly

fs/jbd2/transaction.c

+16 −15
Original line number Diff line number Diff line
@@ -519,7 +519,7 @@ EXPORT_SYMBOL(jbd2__journal_start); 




/**

 * handle_t *jbd2_journal_start() - Obtain a new handle.

 * jbd2_journal_start() - Obtain a new handle.

 * @journal: Journal to start transaction on.

 * @nblocks: number of block buffer we might modify

 *
@@ -566,7 +566,7 @@ void jbd2_journal_free_reserved(handle_t *handle) 
EXPORT_SYMBOL(jbd2_journal_free_reserved);



/**

 * int jbd2_journal_start_reserved() - start reserved handle

 * jbd2_journal_start_reserved() - start reserved handle

 * @handle: handle to start

 * @type: for handle statistics

 * @line_no: for handle statistics
@@ -620,7 +620,7 @@ int jbd2_journal_start_reserved(handle_t *handle, unsigned int type, 
EXPORT_SYMBOL(jbd2_journal_start_reserved);



/**

 * int jbd2_journal_extend() - extend buffer credits.

 * jbd2_journal_extend() - extend buffer credits.

 * @handle:  handle to 'extend'

 * @nblocks: nr blocks to try to extend by.

 * @revoke_records: number of revoke records to try to extend by.
@@ -745,7 +745,7 @@ static void stop_this_handle(handle_t *handle) 
}



/**

 * int jbd2_journal_restart() - restart a handle .

 * jbd2__journal_restart() - restart a handle .

 * @handle:  handle to restart

 * @nblocks: nr credits requested

 * @revoke_records: number of revoke record credits requested
@@ -815,7 +815,7 @@ int jbd2_journal_restart(handle_t *handle, int nblocks) 
EXPORT_SYMBOL(jbd2_journal_restart);



/**

 * void jbd2_journal_lock_updates () - establish a transaction barrier.

 * jbd2_journal_lock_updates () - establish a transaction barrier.

 * @journal:  Journal to establish a barrier on.

 *

 * This locks out any further updates from being started, and blocks
@@ -874,7 +874,7 @@ void jbd2_journal_lock_updates(journal_t *journal) 
}



/**

 * void jbd2_journal_unlock_updates (journal_t* journal) - release barrier

 * jbd2_journal_unlock_updates () - release barrier

 * @journal:  Journal to release the barrier on.

 *

 * Release a transaction barrier obtained with jbd2_journal_lock_updates().
@@ -1182,7 +1182,8 @@ out: 
}



/**

 * int jbd2_journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update.

 * jbd2_journal_get_write_access() - notify intent to modify a buffer

 *				     for metadata (not data) update.

 * @handle: transaction to add buffer modifications to

 * @bh:     bh to be used for metadata writes

 *
@@ -1226,7 +1227,7 @@ int jbd2_journal_get_write_access(handle_t *handle, struct buffer_head *bh) 
 * unlocked buffer beforehand. */



/**

 * int jbd2_journal_get_create_access () - notify intent to use newly created bh

 * jbd2_journal_get_create_access () - notify intent to use newly created bh

 * @handle: transaction to new buffer to

 * @bh: new buffer.

 *
@@ -1306,7 +1307,7 @@ out: 
}



/**

 * int jbd2_journal_get_undo_access() -  Notify intent to modify metadata with

 * jbd2_journal_get_undo_access() -  Notify intent to modify metadata with

 *     non-rewindable consequences

 * @handle: transaction

 * @bh: buffer to undo
@@ -1383,7 +1384,7 @@ out: 
}



/**

 * void jbd2_journal_set_triggers() - Add triggers for commit writeout

 * jbd2_journal_set_triggers() - Add triggers for commit writeout

 * @bh: buffer to trigger on

 * @type: struct jbd2_buffer_trigger_type containing the trigger(s).

 *
@@ -1425,7 +1426,7 @@ void jbd2_buffer_abort_trigger(struct journal_head *jh, 
}



/**

 * int jbd2_journal_dirty_metadata() -  mark a buffer as containing dirty metadata

 * jbd2_journal_dirty_metadata() -  mark a buffer as containing dirty metadata

 * @handle: transaction to add buffer to.

 * @bh: buffer to mark

 *
@@ -1593,7 +1594,7 @@ out: 
}



/**

 * void jbd2_journal_forget() - bforget() for potentially-journaled buffers.

 * jbd2_journal_forget() - bforget() for potentially-journaled buffers.

 * @handle: transaction handle

 * @bh:     bh to 'forget'

 *
@@ -1762,7 +1763,7 @@ drop: 
}



/**

 * int jbd2_journal_stop() - complete a transaction

 * jbd2_journal_stop() - complete a transaction

 * @handle: transaction to complete.

 *

 * All done for a particular handle.
@@ -2080,7 +2081,7 @@ out: 
}



/**

 * int jbd2_journal_try_to_free_buffers() - try to free page buffers.

 * jbd2_journal_try_to_free_buffers() - try to free page buffers.

 * @journal: journal for operation

 * @page: to try and free

 *
@@ -2411,7 +2412,7 @@ zap_buffer_unlocked: 
}



/**

 * void jbd2_journal_invalidatepage()

 * jbd2_journal_invalidatepage()

 * @journal: journal to use for flush...

 * @page:    page to flush

 * @offset:  start of the range to invalidate

include/linux/jbd2.h

+1 −1
Original line number Diff line number Diff line
@@ -401,7 +401,7 @@ static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh) 
#define JI_WAIT_DATA (1 << __JI_WAIT_DATA)



/**

 * struct jbd_inode - The jbd_inode type is the structure linking inodes in

 * struct jbd2_inode - The jbd_inode type is the structure linking inodes in

 * ordered mode present in a transaction so that we can sync them during commit.

 */

struct jbd2_inode {

CRA Git | Maintained and supported by SUSTech CRA and CCSE