Patch Tagging Guidelines (aka DEP3) -- Adopting in Ubuntu?

[Martin Pitt-4]

Hello all,

many of us have added metadata to Ubuntu package patches for a while
now, following

  https://wiki.ubuntu.com/UbuntuDevelopment/PatchTaggingGuidelines

This was discussed a while ago with Debian, and now resulted in a
similar proposal for Debian (see below). Debian's proposal is not
vendor-specific (like our's), and also more flexible.

I'd like to update our PatchTaggingGuidelines to refer to the DEP3
now, and give some updated Ubuntu examples.

That doesn't mean that we need to do a rush and convert all our
patches to the new format, but whenever we create a new one, or work
on an existing one, we should update the meta information. (Keep in
mind that these are "guidelines", not "policy").

Does anyone have objections to that?

Thanks,

Martin

----- Forwarded message from Raphael Hertzog <hertzog@...> -----

Date: Mon, 7 Sep 2009 23:03:37 +0200
From: Raphael Hertzog <hertzog@...>
To: debian-devel-announce@...
Subject: Patch Tagging Guidelines (aka DEP3)
X-Spam-Status: No, score=0.0 required=4.0 tests=AWL,BAYES_50 autolearn=no
        version=3.2.5
Mail-Followup-To: debian-devel@...

Hello,

after several rounds of discussion on -devel, we now have a
new standard defining meta-information to integrate on patches that we
distribute/apply in our packages:
http://dep.debian.net/deps/dep3/

I just changed the status of this Debian Enhancement Proposal to
CANDIDATE, that means that you are all encouraged to make use of it and
try it out for real. Hopefully, http://patch-tracker.debian.org will gain
support of this format and will allow smarter browsing based on those
information.

You are welcome to share your feedback about this format on -devel, if we
identify shortcomings or possible enhancements, we can still update
the proposal (but only after we had time to get some real feedback
based on actual usage of this format).

Feel free to update (Debian specific) tools that generate patches to
auto-generate a DEP3 header ready to be filled by the maintainer. Using
the format is a clear step forward towards more transparency on our local
changes, but it should not be difficul to use, thus some integration in
our tools is welcome.

Cheers,
--
Raphaël Hertzog



----- End forwarded message -----

--
Martin Pitt                        | http://www.piware.de
Ubuntu Developer (www.ubuntu.com)  | Debian Developer  (www.debian.org)


--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[James Westby-2]

On Wed Sep 23 23:43:29 +0100 2009 Martin Pitt wrote:

> Hello all,
>
> many of us have added metadata to Ubuntu package patches for a while
> now, following
>
>   https://wiki.ubuntu.com/UbuntuDevelopment/PatchTaggingGuidelines
>
> This was discussed a while ago with Debian, and now resulted in a
> similar proposal for Debian (see below). Debian's proposal is not
> vendor-specific (like our's), and also more flexible.

Yes, we should switch.

> I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> now, and give some updated Ubuntu examples.

However, it's not clear that they are finalised, given further discussion
on debian-devel. While it may not be an incompatible change, are we
better off playing "wait and see" to avoid perhaps switching twice?

  http://lists.debian.org/debian-devel/2009/09/msg00408.html

Thanks,

James

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Raphael Hertzog]

Le jeudi 24 septembre 2009, James Westby a écrit :
> > I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> > now, and give some updated Ubuntu examples.
>
> However, it's not clear that they are finalised, given further discussion
> on debian-devel. While it may not be an incompatible change, are we
> better off playing "wait and see" to avoid perhaps switching twice?
>
>   http://lists.debian.org/debian-devel/2009/09/msg00408.html

I expect to change it yes, for better compatibily with git-format-patch.
But I'll try to not break what we already have.

It will probably be along the lines of headers can be split in two blocks
and any other lines is part of the long description (up to the first
"---\n") with Subject and From new aliases for short description and
Author.

Cheers,
--
Raphaël Hertzog -+- http://www.ouaza.com

Freexian : des développeurs Debian au service des entreprises
http://www.freexian.com

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Martin Pitt-4]

James Westby [2009-09-24  0:46 +0100]:
> However, it's not clear that they are finalised, given further discussion
> on debian-devel. While it may not be an incompatible change, are we
> better off playing "wait and see" to avoid perhaps switching twice?

Agreed. The discussion seems to be very git centric there, but
*shrug*. Aliases for the win :-)

Martin
--
Martin Pitt                        | http://www.piware.de
Ubuntu Developer (www.ubuntu.com)  | Debian Developer  (www.debian.org)

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Stefano Zacchiroli]

On Thu, Sep 24, 2009 at 12:46:50AM +0100, James Westby wrote:
> > I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> > now, and give some updated Ubuntu examples.
>
> However, it's not clear that they are finalised, given further discussion
> on debian-devel. While it may not be an incompatible change, are we
> better off playing "wait and see" to avoid perhaps switching twice?

FWIW, the initiative (as obvious from the subject line) is following the
DEP process. A consequence of that is that it will be (hopefully) clear
when the proposal is finalized, i.e., when it reaches the ACCEPTED
state. The state can be monitored both in the DEP text itself and at
http://dep.debian.net/ .

As Raphael said, the current CANDIDATE version is relatively stable, but
you might want to wait for ACCEPTED before starting "traducing" your
current metadata.

In case you intend to fully adhere to DEP3, it would be nice to state it
more clearly in the wiki page, so that we avoid duplicated (and possibly
incoherent documentation). I'm confident that, if you have purely
wording / presentation improvements that justify having different doc,
Raphael (as the current DEP driver) will be willing to integrate that in
the main text.

Cheers.

--
Stefano Zacchiroli -o- PhD in Computer Science \ PostDoc @ Univ. Paris 7
zack@{upsilon.cc,pps.jussieu.fr,debian.org} -<>- http://upsilon.cc/zack/
Dietro un grande uomo c'è ..|  .  |. Et ne m'en veux pas si je te tutoie
sempre uno zaino ...........| ..: |.... Je dis tu à tous ceux que j'aime


--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Martin Pitt-4]

Hello Stefano,

Stefano Zacchiroli [2009-09-24 15:15 +0200]:
> In case you intend to fully adhere to DEP3, it would be nice to state it
> more clearly in the wiki page, so that we avoid duplicated (and possibly
> incoherent documentation).

I absolutely agree. My intention was actually to drop most of it, and
just wrap the link to DEP3 with an intro paragraph and some ubuntu
specific examples (also wrt. converting existing patches which
followed the current Ubuntu patch tagging guidelines, etc.)

Martin
--
Martin Pitt                        | http://www.piware.de
Ubuntu Developer (www.ubuntu.com)  | Debian Developer  (www.debian.org)


--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Stefano Zacchiroli]

On Thu, Sep 24, 2009 at 03:38:21PM +0200, Martin Pitt wrote:
> Stefano Zacchiroli [2009-09-24 15:15 +0200]:
> > In case you intend to fully adhere to DEP3, it would be nice to state it
> > more clearly in the wiki page, so that we avoid duplicated (and possibly
> > incoherent documentation).
>
> I absolutely agree. My intention was actually to drop most of it, and
> just wrap the link to DEP3 with an intro paragraph and some ubuntu
> specific examples (also wrt. converting existing patches which
> followed the current Ubuntu patch tagging guidelines, etc.)

That would be ideal. But again, if you have text improvements to
suggest, do not hesitate to submit them :-)

TIA,
Cheers.

--
Stefano Zacchiroli -o- PhD in Computer Science \ PostDoc @ Univ. Paris 7
zack@{upsilon.cc,pps.jussieu.fr,debian.org} -<>- http://upsilon.cc/zack/
Dietro un grande uomo c'è ..|  .  |. Et ne m'en veux pas si je te tutoie
sempre uno zaino ...........| ..: |.... Je dis tu à tous ceux que j'aime


--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[James Westby-2]

On Wed Sep 23 23:43:29 +0100 2009 Martin Pitt wrote:

> Hello all,
>
> many of us have added metadata to Ubuntu package patches for a while
> now, following
>
>   https://wiki.ubuntu.com/UbuntuDevelopment/PatchTaggingGuidelines
>
> This was discussed a while ago with Debian, and now resulted in a
> similar proposal for Debian (see below). Debian's proposal is not
> vendor-specific (like our's), and also more flexible.
>
> I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> now, and give some updated Ubuntu examples.

The last developer news on debian-devel-announce included a message
about the changes being made for compatibility with git, so I think
now would be a good time to make the switch in Ubuntu.

Are there any other objections still outstanding?

Thanks,

James

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Stefano Zacchiroli]

On Sat, Oct 10, 2009 at 01:38:58PM +0100, James Westby wrote:
> > I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> > now, and give some updated Ubuntu examples.
>
> The last developer news on debian-devel-announce included a message
> about the changes being made for compatibility with git, so I think
> now would be a good time to make the switch in Ubuntu.
>
> Are there any other objections still outstanding?

Just to be on the safe-side, I'd ask Raphael (as the DEP3 driver) if he
sees any other forthcoming changes, in particular considering the
feedback he probably received after that announce (if any...).

Raphael?

Cheers.

--
Stefano Zacchiroli -o- PhD in Computer Science \ PostDoc @ Univ. Paris 7
zack@{upsilon.cc,pps.jussieu.fr,debian.org} -<>- http://upsilon.cc/zack/
Dietro un grande uomo c'è ..|  .  |. Et ne m'en veux pas si je te tutoie
sempre uno zaino ...........| ..: |.... Je dis tu à tous ceux que j'aime


--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Raphael Hertzog-3]

On Tue, 13 Oct 2009, Stefano Zacchiroli wrote:

> On Sat, Oct 10, 2009 at 01:38:58PM +0100, James Westby wrote:
> > > I'd like to update our PatchTaggingGuidelines to refer to the DEP3
> > > now, and give some updated Ubuntu examples.
> >
> > The last developer news on debian-devel-announce included a message
> > about the changes being made for compatibility with git, so I think
> > now would be a good time to make the switch in Ubuntu.
> >
> > Are there any other objections still outstanding?
>
> Just to be on the safe-side, I'd ask Raphael (as the DEP3 driver) if he
> sees any other forthcoming changes, in particular considering the
> feedback he probably received after that announce (if any...).

No, I don't see any other forthcoming changes, and I did not get any bad
feedback after that change.

Cheers,
--
Raphaël Hertzog

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel

[Martin Pitt-4]

James Westby [2009-10-10 13:38 +0100]:
> Are there any other objections still outstanding?

Almost a month has passed without any, so I made the change to

  https://wiki.ubuntu.com/UbuntuDevelopment/PatchTaggingGuidelines

now. This now by and large just forwards to DEP-3.

I'll also send this to u-d-a@ now.

Thanks,

Martin
--
Martin Pitt                        | http://www.piware.de
Ubuntu Developer (www.ubuntu.com)  | Debian Developer  (www.debian.org)

--
ubuntu-devel mailing list
ubuntu-devel@...
Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/ubuntu-devel