diff mbox series

[12/17] bcache: fix code comments style

Message ID 20180809064320.10229-13-colyli@suse.de (mailing list archive)
State New, archived
Headers show
Series fixes reported by checkpatch.pl | expand

Commit Message

Coly Li Aug. 9, 2018, 6:43 a.m. UTC
This patch fixes 3 style issues warned by checkpatch.pl,
- Comment lines are not aligned
- Comments use "/*" on subsequent lines
- Comment lines use a trailing "*/"

Signed-off-by: Coly Li <colyli@suse.de>
---
 drivers/md/bcache/super.c | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

Comments

Coly Li Aug. 10, 2018, 6:55 a.m. UTC | #1
On 2018/8/10 11:10 AM, shenghui wrote:
> 
> 
> On 08/09/2018 02:43 PM, Coly Li wrote:
>> This patch fixes 3 style issues warned by checkpatch.pl,
>> - Comment lines are not aligned
>> - Comments use "/*" on subsequent lines
>> - Comment lines use a trailing "*/"
>>
>> Signed-off-by: Coly Li <colyli@suse.de>
>> ---
>>  drivers/md/bcache/super.c | 22 +++++++++++++---------
>>  1 file changed, 13 insertions(+), 9 deletions(-)
>>
>> diff --git a/drivers/md/bcache/super.c b/drivers/md/bcache/super.c
>> index eac0d5d1ada3..a8b751ba3ebc 100644
>> --- a/drivers/md/bcache/super.c
>> +++ b/drivers/md/bcache/super.c
>> @@ -465,8 +465,8 @@ static struct uuid_entry *uuid_find_empty(struct cache_set *c)
>>   * Bucket priorities/gens:
>>   *
>>   * For each bucket, we store on disk its
>> -   * 8 bit gen
>> -   * 16 bit priority
>> + *   8 bit gen
>> + *  16 bit priority
>>   *
>>   * See alloc.c for an explanation of the gen. The priority is used to implement
>>   * lru (and in the future other) cache replacement policies; for most purposes
>> @@ -934,8 +934,10 @@ void bch_cached_dev_run(struct cached_dev *dc)
>>  
>>  	add_disk(d->disk);
>>  	bd_link_disk_holder(dc->bdev, dc->disk.disk);
>> -	/* won't show up in the uevent file, use udevadm monitor -e instead
>> -	 * only class / kset properties are persistent */
>> +	/*
>> +	 * won't show up in the uevent file, use udevadm monitor -e instead
>> +	 * only class / kset properties are persistent
>> +	 */
>>  	kobject_uevent_env(&disk_to_dev(d->disk)->kobj, KOBJ_CHANGE, env);
>>  	kfree(env[1]);
>>  	kfree(env[2]);
>> @@ -1104,8 +1106,9 @@ int bch_cached_dev_attach(struct cached_dev *dc, struct cache_set *c,
>>  		}
>>  	}
>>  
>> -	/* Deadlocks since we're called via sysfs...
>> -	sysfs_remove_file(&dc->kobj, &sysfs_attach);
>> +	/*
>> +	 * Deadlocks since we're called via sysfs...
>> +	 * sysfs_remove_file(&dc->kobj, &sysfs_attach);
>>  	 */
>>  
>>  	if (bch_is_zero(u->uuid, 16)) {
>> @@ -1468,9 +1471,10 @@ bool bch_cache_set_error(struct cache_set *c, const char *fmt, ...)
>>  	if (test_and_set_bit(CACHE_SET_IO_DISABLE, &c->flags))
>>  		pr_info("CACHE_SET_IO_DISABLE already set");
>>  
>> -	/* XXX: we can be called from atomic context
>> -	acquire_console_sem();
>> -	*/
>> +	/*
>> +	 * XXX: we can be called from atomic context
>> +	 * acquire_console_sem();
>> +	 */
>>  
>>  	pr_err("bcache: error on %pU: ", c->sb.set_uuid);
>>  
>>
> 
> Hi Coly,
> 
> I noticed some missing:
> 	bset.c:405:/* I have no idea why this code works... and I'm the one who wrote it

This is a single line comment, IMHO it is OK.

> 	bset.c:796:     /* k is the key we just inserted; we need to find the entry in the
> 	bset.c:804:     /* Adjust all the lookup table entries, and find a new key for any that
> 	writeback.c:471:                        /* We've acquired a semaphore for the maximum
> 

The above lines should be fixed, I will update them in v2 series.

> And some comments start with '/**', like:
>  85 /**
>  86  * bch_hprint - formats @v to human readable string for sysfs.

I see this kind of comment for library routines, the original author may
just treat them as library code. So it's OK for me.

Thanks for your review.

Coly Li
diff mbox series

Patch

diff --git a/drivers/md/bcache/super.c b/drivers/md/bcache/super.c
index eac0d5d1ada3..a8b751ba3ebc 100644
--- a/drivers/md/bcache/super.c
+++ b/drivers/md/bcache/super.c
@@ -465,8 +465,8 @@  static struct uuid_entry *uuid_find_empty(struct cache_set *c)
  * Bucket priorities/gens:
  *
  * For each bucket, we store on disk its
-   * 8 bit gen
-   * 16 bit priority
+ *   8 bit gen
+ *  16 bit priority
  *
  * See alloc.c for an explanation of the gen. The priority is used to implement
  * lru (and in the future other) cache replacement policies; for most purposes
@@ -934,8 +934,10 @@  void bch_cached_dev_run(struct cached_dev *dc)
 
 	add_disk(d->disk);
 	bd_link_disk_holder(dc->bdev, dc->disk.disk);
-	/* won't show up in the uevent file, use udevadm monitor -e instead
-	 * only class / kset properties are persistent */
+	/*
+	 * won't show up in the uevent file, use udevadm monitor -e instead
+	 * only class / kset properties are persistent
+	 */
 	kobject_uevent_env(&disk_to_dev(d->disk)->kobj, KOBJ_CHANGE, env);
 	kfree(env[1]);
 	kfree(env[2]);
@@ -1104,8 +1106,9 @@  int bch_cached_dev_attach(struct cached_dev *dc, struct cache_set *c,
 		}
 	}
 
-	/* Deadlocks since we're called via sysfs...
-	sysfs_remove_file(&dc->kobj, &sysfs_attach);
+	/*
+	 * Deadlocks since we're called via sysfs...
+	 * sysfs_remove_file(&dc->kobj, &sysfs_attach);
 	 */
 
 	if (bch_is_zero(u->uuid, 16)) {
@@ -1468,9 +1471,10 @@  bool bch_cache_set_error(struct cache_set *c, const char *fmt, ...)
 	if (test_and_set_bit(CACHE_SET_IO_DISABLE, &c->flags))
 		pr_info("CACHE_SET_IO_DISABLE already set");
 
-	/* XXX: we can be called from atomic context
-	acquire_console_sem();
-	*/
+	/*
+	 * XXX: we can be called from atomic context
+	 * acquire_console_sem();
+	 */
 
 	pr_err("bcache: error on %pU: ", c->sb.set_uuid);