Skip to content

Commit 5f26710

Browse files
committed
Mention the SWHID source-repository format in the usage documentation
1 parent e54c24c commit 5f26710

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/source/usage.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Using ``repo2docker``
1414
follows :ref:`specification`. repo2docker is called with the URL of a Git repository,
1515
a `DOI <https://en.wikipedia.org/wiki/Digital_object_identifier>`_ from Zenodo or Figshare,
1616
a `Handle <https://en.wikipedia.org/wiki/Handle_System>`_ or DOI from a Dataverse installation,
17+
a `SWHID`_ of a directory of a revision archived in the
18+
`Software Heritage Archive <https://archive.softwareheritage.org>`_,
1719
or a path to a local directory.
1820

1921
It then performs these steps:
@@ -36,7 +38,8 @@ repo2docker is called with this command::
3638
where ``<source-repository>`` is:
3739

3840
* a URL of a Git repository (``https://github.com/binder-examples/requirements``),
39-
* a Zenodo DOI (``10.5281/zenodo.1211089``), or
41+
* a Zenodo DOI (``10.5281/zenodo.1211089``),
42+
* a SWHID_ (``swh:1:rev:999dd06c7f679a2714dfe5199bdca09522a29649``), or
4043
* a path to a local directory (``a/local/directory``)
4144

4245
of the source repository you want to build.
@@ -132,3 +135,4 @@ Command line API
132135

133136

134137
.. _Pytudes: https://github.com/norvig/pytudes
138+
.. _SWHID: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html

0 commit comments

Comments
 (0)