Page MenuHomeSoftware Heritage

spec-meta-deposit: specify what SWHID context qualifiers are allowed.
ClosedPublic

Authored by vlorentz on Tue, Sep 8, 3:23 PM.

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

vlorentz created this revision.Tue, Sep 8, 3:23 PM

Build is green

Patch application report for D3895 (id=13732)

Could not rebase; Attempt merge onto 7c5c84b595...

Merge made by the 'recursive' strategy.
 docs/specs/spec-meta-deposit.rst | 115 +++++++++++++++++++++++----------------
 1 file changed, 67 insertions(+), 48 deletions(-)
Changes applied before test
commit 1ca73d00a2b3a42150d5d6a4f6094cb25e7be478
Merge: 7c5c84b5 4d57a50d
Author: Jenkins user <jenkins@localhost>
Date:   Tue Sep 8 13:29:50 2020 +0000

    Merge branch 'diff-target' into HEAD

commit 4d57a50db0dc19fe28b3f6a04875ee1169937cfd
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Sep 8 15:23:39 2020 +0200

    spec-meta-deposit: specify what SWHID context qualifiers are allowed.

commit 3b2b01e8c239f057f06594f3cdc3327a7ef37434
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Sep 8 15:23:01 2020 +0200

    spec-meta-deposit: allow depositing metadata on all object types.
    
    We can do it easily, so there's no need to artificially
    restrict object types.

commit 70a1746a2a6de13ab23a7219e407ebac13118a38
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Sep 8 15:22:09 2020 +0200

    spec-meta-deposit: only allow depositing metadata on one object at a time.
    
    Depositing on multiple objects at the same time may have
    tricky semantics, and I don't see a use case right now.
    
    But we can allow later by simply using multiple tags in
    the <swh:reference> tree.

commit 0b5b85504af05ae5ea3eb4184b078d4ec299d95a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Sep 8 15:19:45 2020 +0200

    spec-meta-deposit: clarify wording and examples.

commit 76c5256526f1706dd57e7f55573b2eb484e80767
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Sep 8 15:13:56 2020 +0200

    spec-meta-deposit: fix XML indent

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/61/ for more details.

moranegg added inline comments.
docs/specs/spec-meta-deposit.rst
109

the only other qualifier is `line` .
I propose to keep it simple with :

The ``line`` qualifier isn't allowed, due to the limitation of the metadata storage, which 
can't store metadata at the code fragment level.
ardumont accepted this revision.Tue, Sep 8, 5:17 PM
ardumont added a subscriber: ardumont.

lgtm

Morane's suggestion sounds nice as well ;)

This revision is now accepted and ready to land.Tue, Sep 8, 5:17 PM
vlorentz added inline comments.Thu, Sep 10, 9:13 AM
docs/specs/spec-meta-deposit.rst
109

I know. The point is to future-proof this specification against future versions of the SWHID spec, which might add other qualifiers

This revision was landed with ongoing or failed builds.Fri, Sep 11, 10:35 AM
This revision was automatically updated to reflect the committed changes.

Build is green

Patch application report for D3895 (id=13820)

Rebasing onto ec8dcc1ead...

First, rewinding head to replay your work on top of it...
Fast-forwarded diff-target to base-revision-67-D3895.
Changes applied before test

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/67/ for more details.