From 5f26710d0108b5751bd846731caab80c5c5b03f6 Mon Sep 17 00:00:00 2001 From: David Douard Date: Thu, 26 Nov 2020 15:21:06 +0100 Subject: [PATCH] Mention the SWHID source-repository format in the usage documentation --- docs/source/usage.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 6643038e8..bdac9b835 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -14,6 +14,8 @@ Using ``repo2docker`` follows :ref:`specification`. repo2docker is called with the URL of a Git repository, a `DOI `_ from Zenodo or Figshare, a `Handle `_ or DOI from a Dataverse installation, +a `SWHID`_ of a directory of a revision archived in the +`Software Heritage Archive `_, or a path to a local directory. It then performs these steps: @@ -36,7 +38,8 @@ repo2docker is called with this command:: where ```` is: * a URL of a Git repository (``https://github.com/binder-examples/requirements``), - * a Zenodo DOI (``10.5281/zenodo.1211089``), or + * a Zenodo DOI (``10.5281/zenodo.1211089``), + * a SWHID_ (``swh:1:rev:999dd06c7f679a2714dfe5199bdca09522a29649``), or * a path to a local directory (``a/local/directory``) of the source repository you want to build. @@ -132,3 +135,4 @@ Command line API .. _Pytudes: https://github.com/norvig/pytudes +.. _SWHID: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html