Skip to content

Commit

Permalink
Deployed cbf2db9 to dev with MkDocs 1.3.0 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 23, 2023
1 parent c818e2c commit e3c667c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions dev/6.Qualified_identifiers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h3 id="qualifiers">Qualifiers</h3>
<li><em>fragment qualifiers</em> (see 6.1), that identify subparts of a software artifact; or</li>
<li><em>context qualifiers</em> (see 6.2), that provide additional context on the software artifact.</li>
</ul>
<p>Each qualifier is specified as a key-value pair, using a <code>=</code> character as a separator.
<p>Each qualifier is specified as a key-value pair, using an <code>=</code> character as a separator.
Qualifiers are separated from the core identifier and from each other by using a <code>;</code> character.</p>
<p>Some qualifiers are valid for specific object types,
and the validity of some qualifiers depends on the presence of other qualifiers.
Expand All @@ -164,15 +164,15 @@ <h3 id="611-lines-qualifier">6.1.1 Lines qualifier</h3>
<p>A "line" in the context of a file content refers to a sequence of characters that ends with a line break. This line can contain text, code, or any other form of data. In this specification, the line break is the ASCII LF character.
The "lines" qualifier allows to designate a line range inside a content.
The range can be a single line number, or a pair of line numbers separated by the ASCII <code>-</code> character.
Line numbers start from 1, and range is inclusive, i.e. the fragment includes both the lines numbered as start and end of the range.</p>
Line numbers start from 1, and the range is inclusive, i.e. the fragment includes both the lines numbered as the start and end of the range.</p>
<p>For example, <a href="https://archive.softwareheritage.org/swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;lines=9-15"><code>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;lines=9-15</code></a>
designates the function <code>generate_input_stream</code> that is found at lines 9 to 15 of the <em>content</em> with core SWHID <code>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b</code>.</p>
<p>Notice that the notion of "line number" is not always meaningful: the content
may be a binary file, or a file that uses non standard line termination character(s).</p>
<h3 id="612-bytes-qualifier">6.1.2 Bytes qualifier</h3>
<p>To overcome the limitations of the lines qualifier, the bytes qualifier allows
to designate a byte range inside a content. The range can be a single byte number, or a pair of byte numbers separated by <code>-</code>.
Byte numbers start from 0, and range is inclusive, i.e. the fragment includes both the bytes numbered as start and end of the range.
designation of a byte range inside a content. The range can be a single byte number, or a pair of byte numbers separated by <code>-</code>.
Byte numbers start from 0, and the range is inclusive, i.e. the fragment includes both the bytes numbered as the start and end of the range.
If the range is a single byte number, it designates the byte at that specific position.</p>
<p>For example, <code>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;bytes=154-315</code>
designates the same function <code>generate_input_stream</code> as in the example above, but
Expand All @@ -181,17 +181,17 @@ <h2 id="62-context-qualifiers">6.2 Context qualifiers</h2>
<p>There are four context qualifiers, <code>origin</code>, <code>visit</code>, <code>path</code> and <code>anchor</code>.
Each context qualifier MUST appear at most once.</p>
<h3 id="621-origin-qualifier">6.2.1 Origin qualifier</h3>
<p>This qualifier allows to declare the <em>software origin</em> where the
<p>This qualifier allows declaration of the <em>software origin</em> where the
object has been found or observed, as an URI.</p>
<p>For example, <a href="https://archive.softwareheritage.org/swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git"><code>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git</code></a>
indicates that the content seen previously with the function <code>generate_input_stream</code> has
been seen in the Git repository at <code>https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git</code></p>
<p>This qualifier may be helpful 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 (it is the case of the example above, as
can change or disappear over time (as is the case in the example above, since
gitorious.org was shut down in 2015).</p>
<h3 id="622-visit-qualifier">6.2.2 Visit qualifier</h3>
<p>This qualifier allows to add the core SWHID identifier of the <em>snapshot</em>
<p>This qualifier allows addition of the core SWHID identifier of the <em>snapshot</em>
of the repository where the object has been found or observed.</p>
<p>For example, <a href="https://archive.softwareheritage.org/swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9"><code>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9</code></a>
indicates that the content seen previously with the function <code>generate_input_stream</code> has
Expand All @@ -200,7 +200,7 @@ <h3 id="622-visit-qualifier">6.2.2 Visit qualifier</h3>
<p>This qualifier is only valid when the <code>origin</code> qualifier is also present.
Otherwise, it MUST be ignored.</p>
<h3 id="623-path-qualifier">6.2.3 Path qualifier</h3>
<p>This qualifier allows to declare the <em>absolute file path</em>, from the <em>root
<p>This qualifier allows declaration of the <em>absolute file path</em>, from the <em>root
directory</em> associated to the <em>anchor node</em>, to the object designated by the core
SWHID identifier; when the anchor denotes a directory, a revision or a release,
the root directory is uniquely determined; when the anchor denotes a snapshot,
Expand All @@ -214,7 +214,7 @@ <h3 id="623-path-qualifier">6.2.3 Path qualifier</h3>
Otherwise, it MUST be ignored.</p>
<h3 id="624-anchor-qualifier">6.2.4 Anchor qualifier</h3>
<p>This qualifier is used in conjunction with the <code>path</code> qualifier.
It allows to identify a node in the Merkle DAG relative to which
It allows identification of a node in the Merkle DAG relative to which
a <em>path to the object</em> is specified, as the core identifier of a directory,
a revision, a release or a snapshot. See the example provided for the
<code>path</code> qualifier.</p>
Expand All @@ -235,7 +235,7 @@ <h3 id="63-comparing-qualified-swhids">6.3 Comparing qualified SWHIDs</h3>
</ul>
<p>Note that the order of the qualifiers does not matter for comparison purposes.</p>
<h3 id="64-recommendations">6.4 Recommendations</h3>
<p>We recommend to equip identifiers meant to be shared with as many
<p>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:
<code>origin</code>, <code>visit</code>, <code>anchor</code>, <code>path</code>, <code>lines</code> or <code>bytes</code>. </p>
Expand Down
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,5 +170,5 @@ <h1 id="the-swhid-specification-version-11">The SWHID Specification Version 1.1<

<!--
MkDocs version : 1.3.0
Build Date UTC : 2023-10-23 13:45:43.988794+00:00
Build Date UTC : 2023-10-23 13:47:38.614365+00:00
-->
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

Binary file modified dev/sitemap.xml.gz
Binary file not shown.

0 comments on commit e3c667c

Please # to comment.