[PATCH] fs/ext2: ext2_readdir comment about returns

[PATCH] fs/ext2: ext2_readdir comment about returns

[Jérémy Cochoy]

From:Jeremy Cochoy <jeremy.cochoy@gmail.com>

Hello,

I submit a short correction about a comment in ext2/dir.c

(I've already send it but it wasn't the good patch format and i didn't
cc the right people.)

PS: Please excuse me if I make mistakes with the netiquette, it's my
first patch and i wich to send more useful patchs next time, without
hurting your eyes.

Best regards,

-----
diff --git a/fs/ext2/dir.c b/fs/ext2/dir.c
index 6cde970..fc2bd05 100644
--- a/fs/ext2/dir.c
+++ b/fs/ext2/dir.c
@@ -353,8 +353,8 @@ ext2_readdir (struct file * filp, void * dirent,
filldir_t filldir)
 * ext2_find_entry()
 *
 * finds an entry in the specified directory with the wanted name. It
- * returns the page in which the entry was found, and the entry itself
- * (as a parameter - res_dir). Page is returned mapped and unlocked.
+ * returns the page in which the entry was found (as a parameter - res_page),
+ * and the entry itself. Page is returned mapped and unlocked.
 * Entry is guaranteed to be valid.
 */
struct ext2_dir_entry_2 *ext2_find_entry (struct inode * dir,

--
Jérémy Cochoy - L1 MI (Lyon1)
Mail : jeremy.cochoy@gmail.com
Tel : 06-43-01-74-02
Alias Zenol - http://zenol.fr

Re: [PATCH] fs/ext2: ext2_readdir comment about returns

[Jan Kara]

  Hello,

On Mon 30-11-09 00:30:55, Jérémy Cochoy wrote:
> From:Jeremy Cochoy <jeremy.cochoy@gmail.com>
> I submit a short correction about a comment in ext2/dir.c
> 
> (I've already send it but it wasn't the good patch format and i didn't
> cc the right people.)
> 
> PS: Please excuse me if I make mistakes with the netiquette, it's my
> first patch and i wich to send more useful patchs next time, without
> hurting your eyes.
  Thanks for the patch. I'd like to point you to the
Documentation/SubmittingPatches document where is described how a proper
patch submission should look like. Most importantly I miss a Signed-off-by
line (item 12 in the document) - without it the patch cannot be merged.
Also your description in the subject is inaccurate. In my opinion it should
rather be:
ext2: Fixup description of ext2_find_entry
  Finally, it's easier to handle submitted patches with git tools when the
body of email looks like:
Something I want in the changelog additionally to mail subject line
(probably empty in your case).
---
Something that I want to say but should not end up in the changelog.

Patch.

Seeing that you have probably generated your patch from git, git
format-patch and git send-email are useful commands for submitting patches
via email.

								Honza