Comment 10 for bug 2015017

Revision history for this message
Mauricio Faria de Oliveira (mfo) wrote :

Hi Dave (~waveform),

Thanks for all the work to review/sponsor this fix! (And several others!)
It's really appreciated.

In a comparatively small but relevant note, I'd like to humbly point out though
that some DEP-3 headers seem incorrect (IMHO) in the uploads AFAICT based in [1]
(section `Standard fields`):

+Author: David Huggins-Daines <email address hidden>
+Bug: https://gitlab.com/graphviz/graphviz/-/commit/a5606d101af1cc949908a6f0bc19caaa4eb31159
+Description: Corrects scale factor in SVG output

These headers are totally understandable with the context in this bug,
but it might not always be available when looking at it in the future.

If I understand it correctly:

`Author` isn't David (who proposed the patch; so, credit is certainly due, likely in the changelog, e.g., '[ Name ]' before the entry), but the upstream patch author
> Author or From (optional): This field can be used to record the name and email of the patch author ...

`Bug` should be an upstream bug tracker, not the commit/patch:
> Bug-<Vendor> or Bug (optional): It contains one URL pointing to the related bug ...
> The Bug field is reserved for the bug URL in the upstream bug tracker.
> Those fields can be used multiple times ...
> The vendor name is explicitely encoded in the field name"

`Description` is OK, but looks more like `Subject`, as it's single line.
(BTW, this reads way better than the upstream commit title! :)

I think the correct form should be, starting from `git format-patch` or the `.patch`-suffixed URL [2],
which already gives us:
`From:`, which replaces `Author:` ("Author or From (optional)")
`Subject:`, which replaces `Description:` with a different/unstructured format ("Description or Subject (required)")

And we would add 2 optional fields, but which are highly useful (and more standard, considering most SRUs I've seen so far).

Bug-Ubuntu: http://bugs.launchpad.net/bugs/2015017
Origin: [<upstream|backport|vendor>,] https://gitlab.com/graphviz/graphviz/-/commit/a5606d101af1cc949908a6f0bc19caaa4eb31159

[1] https://dep-team.pages.debian.net/deps/dep3/
[2] https://gitlab.com/graphviz/graphviz/-/commit/a5606d101af1cc949908a6f0bc19caaa4eb31159.patch
[3] https://ubuntu-archive-team.ubuntu.com/proposed-migration/oracular/update_excuses.html#graphviz