Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-model
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Renaud Boyer
swh-model
Commits
3f388086
Commit
3f388086
authored
4 years ago
by
Stefano Zacchiroli
Browse files
Options
Downloads
Patches
Plain Diff
SWHID doc: improve wording of intrinsic parts v. the rest
parent
1037e88d
No related branches found
Branches containing commit
Tags
debian/6.10.0-1_swh1
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/persistent-identifiers.rst
+10
-9
10 additions, 9 deletions
docs/persistent-identifiers.rst
with
10 additions
and
9 deletions
docs/persistent-identifiers.rst
+
10
−
9
View file @
3f388086
...
...
@@ -7,18 +7,17 @@ SoftWare Heritage persistent IDentifiers (SWHID)
**version 1.2**
Description
========
===
Overview
========
You can point to objects present in the Software Heritage archive by the means
of **SoftWare Heritage persistent IDentifiers**, or **SWHID** for short, that
are guaranteed to remain stable (persistent) over time. Their syntax, meaning,
and usage is described below. Note that they are identifiers and not URLs, even
though an URL-based resolver for Software Heritage persistent identifiers is
also provided.
though URL-based resolvers for SWHIDs are also available.
A SWHID can point to any software artifact (or "object") available in the
Software Heritage archive. Objects come in different types
, and most notably
:
Software Heritage archive. Objects come in different types:
* contents
* directories
...
...
@@ -27,13 +26,15 @@ Software Heritage archive. Objects come in different types, and most notably:
* snapshots
Each object is identified by an intrinsic, type-specific object identifier that
is embedded in its SWHID as described below. SWHIDs are strong cryptographic
hashes computed on the entire set of object properties to form a `Merkle
structure <https://en.wikipedia.org/wiki/Merkle_tree>`_.
is embedded in its SWHID as described below. The intrinsic identifiers embedded
in SWHIDs are strong cryptographic hashes computed on the entire set of object
properties. Together, these identifiers form a `Merkle structure
<https://en.wikipedia.org/wiki/Merkle_tree>`_, specifically a Merkle DAG.
See the :ref:`Software Heritage data model <data-model>` for an overview of
object types and how they are linked together. See
:py:mod:`swh.model.identifiers` for details on how SWHIDs are computed.
:py:mod:`swh.model.identifiers` for details on how the intrinsic identifiers
embedded in SWHIDs are computed.
Syntax
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment