[PATCH 2/3] [MTD] physmap.c: Add #endif comments

[PATCH 2/3] [MTD] physmap.c: Add #endif comments

[Zev Weiss]

Adding comments to a few of the less painfully-obvious #endifs.

Signed-off-by: Zev Weiss <zevweiss@gmail.com>
---
  drivers/mtd/maps/physmap.c |    6 +++---
  1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/mtd/maps/physmap.c b/drivers/mtd/maps/physmap.c
index 6fba0d4..49e2039 100644
--- a/drivers/mtd/maps/physmap.c
+++ b/drivers/mtd/maps/physmap.c
@@ -244,7 +244,7 @@ static void physmap_flash_shutdown(struct platform_device *dev)
  #define physmap_flash_suspend NULL
  #define physmap_flash_resume NULL
  #define physmap_flash_shutdown NULL
-#endif
+#endif /* CONFIG_PM */

  static struct platform_driver physmap_flash_driver = {
  	.probe		= physmap_flash_probe,
@@ -302,8 +302,8 @@ void physmap_set_partitions(struct mtd_partition *parts, int
num_parts)
  	physmap_flash_data.nr_parts = num_parts;
  	physmap_flash_data.parts = parts;
  }
-#endif
-#endif
+#endif /* CONFIG_MTD_PARTITIONS */
+#endif /* PHYSMAP_COMPAT */

  static int __init physmap_init(void)
  {
-- 
1.5.4.1

Re: [PATCH 2/3] [MTD] physmap.c: Add #endif comments

[Lennert Buytenhek]

On Fri, Sep 12, 2008 at 11:33:03PM -0700, Zev Weiss wrote:

> Adding comments to a few of the less painfully-obvious #endifs.
> 
> Signed-off-by: Zev Weiss <zevweiss@gmail.com>
> ---
>   drivers/mtd/maps/physmap.c |    6 +++---
>   1 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/mtd/maps/physmap.c b/drivers/mtd/maps/physmap.c
> index 6fba0d4..49e2039 100644
> --- a/drivers/mtd/maps/physmap.c
> +++ b/drivers/mtd/maps/physmap.c
> @@ -244,7 +244,7 @@ static void physmap_flash_shutdown(struct platform_device *dev)
>   #define physmap_flash_suspend NULL
>   #define physmap_flash_resume NULL
>   #define physmap_flash_shutdown NULL
> -#endif
> +#endif /* CONFIG_PM */
> 
>   static struct platform_driver physmap_flash_driver = {
>   	.probe		= physmap_flash_probe,
> @@ -302,8 +302,8 @@ void physmap_set_partitions(struct mtd_partition *parts, int
> num_parts)
>   	physmap_flash_data.nr_parts = num_parts;
>   	physmap_flash_data.parts = parts;
>   }
> -#endif
> -#endif
> +#endif /* CONFIG_MTD_PARTITIONS */
> +#endif /* PHYSMAP_COMPAT */

I thought that this was frowned upon.  (I don't like it myself, and
my editor is perfectly well capable of pointing out to me which ifdef
matches up with which endif.)

Re: [PATCH 2/3] [MTD] physmap.c: Add #endif comments

[Zev Weiss]

Lennert Buytenhek wrote:
> On Fri, Sep 12, 2008 at 11:33:03PM -0700, Zev Weiss wrote:
> 
>> Adding comments to a few of the less painfully-obvious #endifs.
>>
>> Signed-off-by: Zev Weiss <zevweiss@gmail.com>
>> ---
>>   drivers/mtd/maps/physmap.c |    6 +++---
>>   1 files changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/mtd/maps/physmap.c b/drivers/mtd/maps/physmap.c
>> index 6fba0d4..49e2039 100644
>> --- a/drivers/mtd/maps/physmap.c
>> +++ b/drivers/mtd/maps/physmap.c
>> @@ -244,7 +244,7 @@ static void physmap_flash_shutdown(struct platform_device *dev)
>>   #define physmap_flash_suspend NULL
>>   #define physmap_flash_resume NULL
>>   #define physmap_flash_shutdown NULL
>> -#endif
>> +#endif /* CONFIG_PM */
>>
>>   static struct platform_driver physmap_flash_driver = {
>>   	.probe		= physmap_flash_probe,
>> @@ -302,8 +302,8 @@ void physmap_set_partitions(struct mtd_partition *parts, int
>> num_parts)
>>   	physmap_flash_data.nr_parts = num_parts;
>>   	physmap_flash_data.parts = parts;
>>   }
>> -#endif
>> -#endif
>> +#endif /* CONFIG_MTD_PARTITIONS */
>> +#endif /* PHYSMAP_COMPAT */
> 
> I thought that this was frowned upon.  (I don't like it myself, and
> my editor is perfectly well capable of pointing out to me which ifdef
> matches up with which endif.)
> 

Ah, OK -- I found it slightly hard to follow the ones that get longer than a 
screenful or so, and I don't have my editor set to match them up nicely (though I 
might look into that).  It's something I'm accustomed to doing and seeing, and I saw 
no mention of it one way or another in Documentation/CodingStyle, so I didn't really 
give it a second thought.