| Message ID | 20181031180650.25329-1-blp@ovn.org |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [ovs-dev] submitting-patches: Advise not to wrap tags across multiple lines. | expand |
On 10/31/2018 11:06 AM, Ben Pfaff wrote: > It makes parsing them more difficult. > > Signed-off-by: Ben Pfaff <blp@ovn.org> > --- > Documentation/internals/contributing/submitting-patches.rst | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst > index 1755c8a6691a..5a314cc60aa7 100644 > --- a/Documentation/internals/contributing/submitting-patches.rst > +++ b/Documentation/internals/contributing/submitting-patches.rst > @@ -145,6 +145,9 @@ The description ends with a series of tags, written one to a line as the last > paragraph of the email. Each tag indicates some property of the patch in an > easily machine-parseable manner. > > +Please don't wrap a tag across multiple lines. If necessary, it's OK to have a > +tag extend beyond the customary maximum width of a commit message. > + > Examples of common tags follow. > > ``Signed-off-by: Author Name <author.name@email.address...>`` +1 Reviewed-by: Greg Rose <gvrose8192@gmail.com>
On Wed, Oct 31, 2018 at 11:06:50AM -0700, Ben Pfaff wrote: > It makes parsing them more difficult. It does, indeed. Acked-by: Flavio Leitner <fbl@sysclose.org> > > Signed-off-by: Ben Pfaff <blp@ovn.org> > --- > Documentation/internals/contributing/submitting-patches.rst | 3 +++ > 1 file changed, 3 insertions(+) > > diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst > index 1755c8a6691a..5a314cc60aa7 100644 > --- a/Documentation/internals/contributing/submitting-patches.rst > +++ b/Documentation/internals/contributing/submitting-patches.rst > @@ -145,6 +145,9 @@ The description ends with a series of tags, written one to a line as the last > paragraph of the email. Each tag indicates some property of the patch in an > easily machine-parseable manner. > > +Please don't wrap a tag across multiple lines. If necessary, it's OK to have a > +tag extend beyond the customary maximum width of a commit message. > + > Examples of common tags follow. > > ``Signed-off-by: Author Name <author.name@email.address...>`` > -- > 2.16.1 > > _______________________________________________ > dev mailing list > dev@openvswitch.org > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
On Wed, Oct 31, 2018 at 03:32:07PM -0300, Flavio Leitner wrote: > On Wed, Oct 31, 2018 at 11:06:50AM -0700, Ben Pfaff wrote: > > It makes parsing them more difficult. > > It does, indeed. > Acked-by: Flavio Leitner <fbl@sysclose.org> Thanks Flavio and Greg, I applied this to master.
diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst index 1755c8a6691a..5a314cc60aa7 100644 --- a/Documentation/internals/contributing/submitting-patches.rst +++ b/Documentation/internals/contributing/submitting-patches.rst @@ -145,6 +145,9 @@ The description ends with a series of tags, written one to a line as the last paragraph of the email. Each tag indicates some property of the patch in an easily machine-parseable manner. +Please don't wrap a tag across multiple lines. If necessary, it's OK to have a +tag extend beyond the customary maximum width of a commit message. + Examples of common tags follow. ``Signed-off-by: Author Name <author.name@email.address...>``
It makes parsing them more difficult. Signed-off-by: Ben Pfaff <blp@ovn.org> --- Documentation/internals/contributing/submitting-patches.rst | 3 +++ 1 file changed, 3 insertions(+)