SWHID spec: add support for IRI

Closes T2379

---

Migrated from D3068 (view on Phabricator)

Some references in the commit message have been migrated:

• T2379 is now swh/meta#2379 (closed)

Build is green

Patch application report for D3068 (id=10906)

Rebasing onto 56cf99ae...

Current branch diff-target is up to date.

Changes applied before test

commit 3ef4843c895586b10ccf734ab9197cdfa630f4a3
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Sun Apr 26 16:44:51 2020 +0200

    SWHID spec: add support for IRI
    
    Closes [T2379](https://forge.softwareheritage.org/T2379 'view original for T2379 on Phabricator')

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

I wonder if we should require extra escapes, like whitespaces and/or angle brackets (to embed SWHIDs in free text)

(And it's out of scope, but I don't think we need to mention % must me escaped, it's already required by the RFC)

Sadly, https://tools.ietf.org/html/rfc3987#section-7.3 is the best I can find on how to embed IRIs in free text; and it doesn't provide much help ("Such applications have to be upgraded to use the IRI syntax as a base for heuristics.").

! In !285 (closed), @vlorentz wrote: I wonder if we should require extra escapes, like whitespaces and/or angle brackets (to embed SWHIDs in free text)

(And it's out of scope, but I don't think we need to mention % must me escaped, it's already required by the RFC)

Good point about %, I'll update the diff to drop it.

Regarding the rest, I think we're good as is, in the sense that we are just stating what is the //minimum// of characters that must be escaped; additional characters can be escaped as desired. We can add a generic sentence to that end (e.g., "others characters //can// be escaped bla bla bla"), if you think it would help conveying this point.

Sounds good!

• SWHID spec: simplify and generalize escaping requirements

Build is green

Patch application report for D3068 (id=10914)

Rebasing onto 56cf99ae...

Current branch diff-target is up to date.

Changes applied before test

commit 137938567f6b6ce8ec590b415a10ae9f0eb0a309
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Mon Apr 27 15:17:50 2020 +0200

    SWHID spec: simplify and generalize escaping requirements

commit 3ef4843c895586b10ccf734ab9197cdfa630f4a3
Author: Stefano Zacchiroli <zack@upsilon.cc>
Date:   Sun Apr 26 16:44:51 2020 +0200

    SWHID spec: add support for IRI
    
    Closes [T2379](https://forge.softwareheritage.org/T2379 'view original for T2379 on Phabricator')

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

Merge request was accepted

approved this merge request

Merge request was merged

closed

mentioned in issue swh/meta#2379 (closed)