Skip to contentSkip to conversation

memory : adjust the ugly comment

PATCH In review Huang Shijie 3 participants 4 messages Sep 25, 2009

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 memory : adjust the ugly comment

The origin comment is too ugly, so modify it more beautiful.

---
 mm/memory.c |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
mm/memory.c +4 -1
index 7e91b5f..6a38caa 100644
@@ -2405,7 +2405,10 @@ restart:
 }
 
 /**
- * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
+ * unmap_mapping_range - unmap the portion of all mmaps in the specified
+ *	 		address_space corresponding to the specified page range
+ * 			in the underlying file.
+ *
  * @mapping: the address space containing mmaps to be unmapped.
  * @holebegin: byte in first page to unmap, relative to the start of
  * the underlying file.  This will be rounded down to a PAGE_SIZE
Signature · 7 lines
1.6.0.6

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to [email protected].  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"[email protected]"> [email protected] </a>
maintainer
#1 lore raw
Quoted 12 lines · On Fri, 25 Sep 2009 17:20:51 +0800 Huang Shijie <[email protected]> wrote:

The origin comment is too ugly, so modify it more beautiful.

---
 mm/memory.c |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
mm/memory.c +0 -0
index 7e91b5f..6a38caa 100644

mm/memory.c restart: · line 2411

Quoted 8 lines
mm/memory.c +4 -1
@@ -2405,7 +2405,10 @@ restart:
 }
 
 /**
- * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
+ * unmap_mapping_range - unmap the portion of all mmaps in the specified
+ *	 		address_space corresponding to the specified page range
+ * 			in the underlying file.
+ *

The comment must all be in a single line so that the kerneldoc tools process it correctly. It's a kerneldoc restriction which all are welcome to fix ;)

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in the body to [email protected]. For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"[email protected]"> [email protected] </a>

#2 lore raw
Quoted 16 lines · Andrew Morton
Quoted 14 lines · On Fri, 25 Sep 2009 17:20:51 +0800 Huang Shijie <[email protected]> wrote:

The origin comment is too ugly, so modify it more beautiful.

---
 mm/memory.c |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
mm/memory.c +0 -0
index 7e91b5f..6a38caa 100644
@@ -2405,7 +2405,10 @@ restart:
 }
 
Quoted 10 lines

mm/memory.c restart: · line 2411

Quoted 6 lines
mm/memory.c +4 -1
 /**
- * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
+ * unmap_mapping_range - unmap the portion of all mmaps in the specified
+ *	 		address_space corresponding to the specified page range
+ * 			in the underlying file.
+ *

The comment must all be in a single line so that the kerneldoc tools process it correctly. It's a kerneldoc restriction which all are welcome to fix ;)

Patch for that (multi-line "short" function descriptions) was merged just a few days ago.

http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=6423133bdee0e07d1c2f8411cb3fe676c207ba33

~Randy

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in the body to [email protected]. For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"[email protected]"> [email protected] </a>

maintainer
#3 lore raw
Quoted 28 lines · On Fri, 25 Sep 2009 11:27:00 -0700 Randy Dunlap <[email protected]> wrote:
Quoted 16 lines · Andrew Morton
Quoted 14 lines · On Fri, 25 Sep 2009 17:20:51 +0800 Huang Shijie <[email protected]> wrote:

The origin comment is too ugly, so modify it more beautiful.

---
 mm/memory.c |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)
mm/memory.c +0 -0
index 7e91b5f..6a38caa 100644
@@ -2405,7 +2405,10 @@ restart:
 }
 
Quoted 10 lines

mm/memory.c restart: · line 2411

Quoted 6 lines
mm/memory.c +4 -1
 /**
- * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
+ * unmap_mapping_range - unmap the portion of all mmaps in the specified
+ *	 		address_space corresponding to the specified page range
+ * 			in the underlying file.
+ *

The comment must all be in a single line so that the kerneldoc tools process it correctly. It's a kerneldoc restriction which all are welcome to fix ;)

Quoted 5 lines

Patch for that (multi-line "short" function descriptions) was merged just a few days ago.

http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=6423133bdee0e07d1c2f8411cb3fe676c207ba33

w00t. Now we have a lot of ugly comments to clean up ;)

I think it would be better to do this as one-patch-per-subsystem rather than as a huge number of tiny patches.

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in the body to [email protected]. For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"[email protected]"> [email protected] </a>