Skip to content

Commit

Permalink
UBI: amend comments after renaming in scan.c
Browse files Browse the repository at this point in the history
Now some commentaries are out-of-date, after we re-named the data
structures - amend them.

Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy@linux.intel.com>
  • Loading branch information
Artem Bityutskiy committed May 20, 2012
1 parent afc15a8 commit 55e93e5
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions drivers/mtd/ubi/scan.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#define UBI_SCAN_UNKNOWN_EC (-1)

/**
* struct ubi_ainf_peb - scanning information about a physical eraseblock.
* struct ubi_ainf_peb - attach information about a physical eraseblock.
* @ec: erase counter (%UBI_SCAN_UNKNOWN_EC if it is unknown)
* @pnum: physical eraseblock number
* @lnum: logical eraseblock number
Expand All @@ -36,8 +36,8 @@
* @u.rb: link in the per-volume RB-tree of &struct ubi_ainf_peb objects
* @u.list: link in one of the eraseblock lists
*
* One object of this type is allocated for each physical eraseblock during
* scanning.
* One object of this type is allocated for each physical eraseblock when
* attaching an MTD device.
*/
struct ubi_ainf_peb {
int ec;
Expand All @@ -53,7 +53,7 @@ struct ubi_ainf_peb {
};

/**
* struct ubi_ainf_volume - scanning information about a volume.
* struct ubi_ainf_volume - attaching information about a volume.
* @vol_id: volume ID
* @highest_lnum: highest logical eraseblock number in this volume
* @leb_count: number of logical eraseblocks in this volume
Expand All @@ -70,7 +70,8 @@ struct ubi_ainf_peb {
* @root: root of the RB-tree containing all the eraseblock belonging to this
* volume (&struct ubi_ainf_peb objects)
*
* One object of this type is allocated for each volume during scanning.
* One object of this type is allocated for each volume when attaching an MTD
* device.
*/
struct ubi_ainf_volume {
int vol_id;
Expand All @@ -86,7 +87,7 @@ struct ubi_ainf_volume {
};

/**
* struct ubi_attach_info - UBI scanning information.
* struct ubi_attach_info - MTD device attaching information.
* @volumes: root of the volume RB-tree
* @corr: list of corrupted physical eraseblocks
* @free: list of free physical eraseblocks
Expand All @@ -100,7 +101,7 @@ struct ubi_ainf_volume {
* @bad_peb_count: count of bad physical eraseblocks
* @maybe_bad_peb_count: count of bad physical eraseblocks which are not marked
* as bad yet, but which look like bad
* @vols_found: number of volumes found during scanning
* @vols_found: number of volumes found
* @highest_vol_id: highest volume ID
* @is_empty: flag indicating whether the MTD device is empty or not
* @min_ec: lowest erase counter value
Expand All @@ -111,9 +112,9 @@ struct ubi_ainf_volume {
* @ec_count: a temporary variable used when calculating @mean_ec
* @scan_leb_slab: slab cache for &struct ubi_ainf_peb objects
*
* This data structure contains the result of scanning and may be used by other
* UBI sub-systems to build final UBI data structures, further error-recovery
* and so on.
* This data structure contains the result of attaching an MTD device and may
* be used by other UBI sub-systems to build final UBI data structures, further
* error-recovery and so on.
*/
struct ubi_attach_info {
struct rb_root volumes;
Expand Down

0 comments on commit 55e93e5

Please sign in to comment.