Skip to content

Commit

Permalink
removed trailing space and multiple blank lines (entirely cosmetic)
Browse files Browse the repository at this point in the history
  • Loading branch information
robbiemorrison committed Nov 2, 2023
1 parent 234d060 commit e59ce1f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
7 changes: 3 additions & 4 deletions Chapters/5.Core_identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The intrinsic identifier of the directory is the SHA1 of the byte sequence obtai
- a NULL byte,
- and the previously obtained serialization.

As an example, `swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505`
As an example, `swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505`
is the SWHID computed from
[a directory containing the source code of the darktable photography application](https://archive.softwareheritage.org/swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505) at
a given point in time of its development on May 4th 2017.
Expand Down Expand Up @@ -245,8 +245,8 @@ As an example, `swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453` is the SWHID
## Note on compatibility with Git

SWHIDs for contents, directories, revisions, and releases are, at present,
compatible with the way the current version of [Git](https://git-scm.com/)
proceeds for
compatible with the way the current version of [Git](https://git-scm.com/)
proceeds for
[computing identifiers](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects) for
its objects. The `<object_id>` part of a SWHID for a content object is the Git
blob identifier of any file with the same content; for a revision it is the Git
Expand All @@ -256,4 +256,3 @@ identifiers, as Git does not have a corresponding object type.
Git compatibility is practical, but incidental and is not guaranteed to be
maintained in future versions of this standard, nor for different versions of
Git.

9 changes: 4 additions & 5 deletions Chapters/6.Qualified_identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ For example, `swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;bytes=154-315`
designates the same function `generate_input_stream` as in the example above, but
does not rely on any convention about line numbers.


## 6.2 Context qualifiers

There are four context qualifiers, `origin`, `visit`, `path` and `anchor`.
Expand All @@ -72,18 +71,18 @@ been seen in the Git repository at `https://gitorious.org/ocamlp3l/ocamlp3l_cvs.

This qualifier may help to get hold of the full repository where a
content has been found, but there is no guarantee of success, as an origin
can change or disappear over time (as is the case in the example above, since
can change or disappear over time (as is the case in the example above, since
gitorious.org was shut down in 2015).

### 6.2.2 Visit qualifier

This qualifier allows addition of the core SWHID identifier of the *snapshot*
This qualifier allows addition of the core SWHID identifier of the *snapshot*
of the repository where the object has been found or observed.

For example, [`swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9`](https://archive.softwareheritage.org/swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9)
indicates that the content seen previously with the function `generate_input_stream` has
been seen in the Git repository at `https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git`, when
its full state had the SWHID core identifier `swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9`.
its full state had the SWHID core identifier `swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9`.

This qualifier is only valid when the `origin` qualifier is also present.
Otherwise, it MUST be ignored.
Expand Down Expand Up @@ -138,7 +137,7 @@ Note that the order of the qualifiers does not matter for comparison purposes.
We recommend equipping identifiers meant for sharing with as many
qualifiers as possible. While qualifiers may be listed in any order, it
is good practice to present them in the following canonical order:
`origin`, `visit`, `anchor`, `path`, `lines` or `bytes`.
`origin`, `visit`, `anchor`, `path`, `lines` or `bytes`.

By adhering to this order, it becomes easier to visually inspect and compare
SWHIDs, especially when dealing with a large number of identifiers.
Expand Down

0 comments on commit e59ce1f

Please sign in to comment.