Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 667432 - DCO_SIGNED_OFF_BY is a misleading name
Summary: DCO_SIGNED_OFF_BY is a misleading name
Status: RESOLVED FIXED
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Repoman (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Portage team
URL:
Whiteboard:
Keywords: InVCS
Depends on:
Blocks: 642072 701268
  Show dependency tree
 
Reported: 2018-10-01 06:19 UTC by Ulrich Müller
Modified: 2020-02-29 02:55 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
man/make.conf.5: Refer to GLEP 76 in DCO_SIGNED_OFF_BY explanation. (0001-man-make.conf.5-Refer-to-GLEP-76-in-DCO_SIGNED_OFF_B.patch,1.46 KB, patch)
2019-11-21 14:25 UTC, Ulrich Müller
Details | Diff
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY. (0001-Rename-DCO_SIGNED_OFF_BY-config-variable-to-SIGNED_O.patch,4.76 KB, patch)
2019-11-22 10:31 UTC, Ulrich Müller
Details | Diff
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY. (0001-Rename-DCO_SIGNED_OFF_BY-config-variable-to-SIGNED_O.patch,4.87 KB, patch)
2019-11-22 17:12 UTC, Ulrich Müller
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2018-10-01 06:19:05 UTC
Since we use our own version of the Certificate of Origin, referring to the DCO in the variable could be misleading. So maybe it would be better to rename it (e.g., to SIGNED_OFF_BY?).


For backwards compatibility, the old name could be kept as an alias for some time, maybe with a deprecation warning?
Comment 1 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2018-10-01 08:03:35 UTC
I'm not sure if we really need to do this but I think it'd be really useful to update the documentation, to:

a. point out what this does in Gentoo (link to GCO?),

b. list that you need to use real name there, and your @gentoo.org address if you're a dev.
Comment 2 Ulrich Müller gentoo-dev 2019-11-21 14:25:49 UTC
Created attachment 597096 [details, diff]
man/make.conf.5: Refer to GLEP 76 in DCO_SIGNED_OFF_BY explanation.

I believe that attached patch will clarify it sufficiently.

Please review.
Comment 3 Zac Medico gentoo-dev 2019-11-21 23:36:25 UTC
If you wanted to rename the variable, you could do it with a compatibility alias like this:

https://gitweb.gentoo.org/proj/portage.git/commit/?id=22e8951521558a4488a44f4bdd276ced7c24b950
Comment 4 Mike Gilbert gentoo-dev 2019-11-22 02:39:52 UTC
I don't really like referring to Gentoo policy in Portage documentation. I feel like this belongs in something like the devmanual instead.
Comment 5 Ulrich Müller gentoo-dev 2019-11-22 02:48:00 UTC
(In reply to Mike Gilbert from comment #4)
> I don't really like referring to Gentoo policy in Portage documentation. I
> feel like this belongs in something like the devmanual instead.

There is a precedent for this, namely a reference to GLEP 23 just above.

But go ahead, if you have a better wording that explains the meaning of Signed-off-by, without referring to GLEP 76. Currently the man page doesn't explain it at all.
Comment 6 Mike Gilbert gentoo-dev 2019-11-22 02:54:21 UTC
The current description seems sufficient to me. It explains the effect of the variable; the rationale belongs elsewhere.
Comment 7 Mike Gilbert gentoo-dev 2019-11-22 03:03:14 UTC
Some other distro might utilize Signed-off-by for some purpose that is distinct from GLEP 76.

GLEP 23 is a technical specification, not a policy.
Comment 8 Ulrich Müller gentoo-dev 2019-11-22 04:06:45 UTC
(In reply to Mike Gilbert from comment #6)
> The current description seems sufficient to me. It explains the effect of
> the variable; the rationale belongs elsewhere.

Huh? The current description doesn't explain anything.

Compare it with git-commit(1):

       -s, --signoff
           Add Signed-off-by line by the committer at the end of the commit
           log message. The meaning of a signoff depends on the project, but
           it typically certifies that committer has the rights to submit this
           work under the same license and agrees to a Developer Certificate
           of Origin (see http://developercertificate.org/ for more
           information).
Comment 9 Mike Gilbert gentoo-dev 2019-11-22 04:51:51 UTC
(In reply to Ulrich Müller from comment #8)
> Huh? The current description doesn't explain anything.

It explains that Signed-off-by will be added to the commit message, which is exactly what happens.
Comment 10 Ulrich Müller gentoo-dev 2019-11-22 05:55:24 UTC
(In reply to Mike Gilbert from comment #9)
> It explains that Signed-off-by will be added to the commit message, which is
> exactly what happens.

But it is totally useless as an explanation.

It is as if we were saying e.g. for MAKEOPTS "these are passed as parameters to make" (which is exactly what it does), but without referring to parallel make and its purpose.
Comment 11 Ulrich Müller gentoo-dev 2019-11-22 10:31:15 UTC
Created attachment 597134 [details, diff]
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.

Updated patch, now also renaming the variable to SIGNED_OFF_BY.

This does no longer mention GLEP 76 in the man page, but adds a short explanation that Signed-off-by has a project specific meaning. Is this acceptable?
Comment 12 Mike Gilbert gentoo-dev 2019-11-22 15:00:42 UTC
(In reply to Ulrich Müller from comment #11)
> This does no longer mention GLEP 76 in the man page, but adds a short
> explanation that Signed-off-by has a project specific meaning. Is this
> acceptable?

That works for me.

I could also live with a GLEP 76 reference, so long as it is clear that it is being used as an example (similar to the git manpage).
Comment 13 Ulrich Müller gentoo-dev 2019-11-22 17:12:43 UTC
Created attachment 597140 [details, diff]
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.

(In reply to Mike Gilbert from comment #12)
> I could also live with a GLEP 76 reference, so long as it is clear that it
> is being used as an example (similar to the git manpage).

Patch updated, with the GLEP 76 reference added as an example.
Comment 14 Mike Gilbert gentoo-dev 2019-11-26 15:56:43 UTC
Comment on attachment 597140 [details, diff]
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.

Looks good to me.
Comment 15 Zac Medico gentoo-dev 2019-11-26 15:59:54 UTC
Comment on attachment 597140 [details, diff]
Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.

Looks good. Please merge.
Comment 16 Larry the Git Cow gentoo-dev 2019-11-26 18:27:58 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage.git/commit/?id=511e00d9f65abea11dfd769baf2ee939e1584ede

commit 511e00d9f65abea11dfd769baf2ee939e1584ede
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2019-11-22 10:19:15 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2019-11-26 18:25:43 +0000

    Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.
    
    Provide compatibility support for old name.
    Update make.conf.5 man page.
    
    Bug: https://bugs.gentoo.org/667432
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 lib/portage/package/ebuild/_config/special_env_vars.py |  2 +-
 lib/portage/package/ebuild/config.py                   |  3 ++-
 man/make.conf.5                                        | 13 ++++++++++---
 repoman/lib/repoman/actions.py                         |  8 +++++---
 4 files changed, 18 insertions(+), 8 deletions(-)
Comment 17 Larry the Git Cow gentoo-dev 2019-11-27 03:45:15 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=3e36007163e56015301e2146c671fb14b3b0af57

commit 3e36007163e56015301e2146c671fb14b3b0af57
Author:     Zac Medico <zmedico@gentoo.org>
AuthorDate: 2019-11-27 03:39:22 +0000
Commit:     Zac Medico <zmedico@gentoo.org>
CommitDate: 2019-11-27 03:39:57 +0000

    sys-apps/portage: Bump to version 2.3.80
    
     #667432 Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.
     #674562 eapply: Drop -s option for patch.
     #689226 emerge --buildpkgonly: respect buildtime hard blockers
     #699986 emerge: add --quickpkg-direct option
    
    Bug: https://bugs.gentoo.org/701268
    Bug: https://bugs.gentoo.org/667432
    Bug: https://bugs.gentoo.org/674562
    Bug: https://bugs.gentoo.org/689226
    Bug: https://bugs.gentoo.org/699986
    Package-Manager: Portage-2.3.80, Repoman-2.3.18
    Signed-off-by: Zac Medico <zmedico@gentoo.org>

 sys-apps/portage/Manifest              |   1 +
 sys-apps/portage/portage-2.3.80.ebuild | 261 +++++++++++++++++++++++++++++++++
 2 files changed, 262 insertions(+)
Comment 18 Larry the Git Cow gentoo-dev 2019-11-27 04:21:37 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=0af2015bc57a267f5f67610a73bde5da16bcc6d4

commit 0af2015bc57a267f5f67610a73bde5da16bcc6d4
Author:     Zac Medico <zmedico@gentoo.org>
AuthorDate: 2019-11-27 04:18:16 +0000
Commit:     Zac Medico <zmedico@gentoo.org>
CommitDate: 2019-11-27 04:19:23 +0000

    app-portage/repoman: Bump to version 2.3.19
    
     #667432 Rename DCO_SIGNED_OFF_BY config variable to SIGNED_OFF_BY.
     #700456 Add --include-profiles=PROFILES
    
    Bug: https://bugs.gentoo.org/667432
    Bug: https://bugs.gentoo.org/700456
    Package-Manager: Portage-2.3.80, Repoman-2.3.19
    Signed-off-by: Zac Medico <zmedico@gentoo.org>

 app-portage/repoman/Manifest              |  1 +
 app-portage/repoman/repoman-2.3.19.ebuild | 63 +++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)