lkml.org 
[lkml]   [2005]   [Oct]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCHv2] Document from line in patch format


On Sun, 2 Oct 2005, Paul Jackson wrote:
>
> Document more details of patch format such as the "from" line
> used to specify the patch author, and provide more references
> for patch guidelines.

One more issue: I'd really prefer that the "---" not be documented as
"optional".

Yes, my tools will also notice "diff -" and "Index: " at the start of the
line as being markers for where the real patch starts, but that's a hack
because people haven't been following the "---" rule. I'd much rather make
it clear that the "---" is supposed to be there, to mark where the end of
the comments are.

Note that after the "---" you can have any amount of explanations that are
not to be committed as comments on why. Not just a "diffstat", but in
general it's an area for explaining why I should commit it or random notes
on the patch. Things that don't necessarily make sense once the patch _is_
committed.

For example, a submitter might want to note that he's working on a better
patch, but that this patch is the minimal one before a release. Things he
wants to tell the maintainer, but that don't necessarily make sense to
anybody else.

So the _diffstat_ is optional (although much preferred, especially for
bigger patches), but the marker of "this is the end of the comments for
the changelog" is not.

Linus
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

\
 
 \ /
  Last update: 2009-11-18 23:46    [W:0.053 / U:0.668 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site