diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@ Git repository and inject into the SWH dataset all contained files that weren't known before. -The main entry points are +The main entry points are: -- :class:`swh.loader.git.loader.GitLoader` for the main loader which ingests a remote git - repository's contents. +- :class:`swh.loader.git.loader.GitLoader` for the main loader which can ingest either + local or remote git repository's contents. This is the main implementation deployed in + production. -- :class:`swh.loader.git.from_disk.GitLoaderFromDisk` which ingests a local git clone +- :class:`swh.loader.git.from_disk.GitLoaderFromDisk` which ingests only local git clone repository. - :class:`swh.loader.git.loader.GitLoaderFromArchive` which ingests a git repository diff --git a/swh/loader/git/from_disk.py b/swh/loader/git/from_disk.py --- a/swh/loader/git/from_disk.py +++ b/swh/loader/git/from_disk.py @@ -17,6 +17,7 @@ # dulwich >= 0.20 from dulwich.objects import EmptyFileException +from deprecated import deprecated import dulwich.objects import dulwich.repo @@ -85,6 +86,7 @@ last = field +@deprecated(version="1.1", reason="Use `swh.loader.git.loader.GitLoader` instead") class GitLoaderFromDisk(DVCSLoader): """Load a git repository from a directory. diff --git a/swh/loader/git/loader.py b/swh/loader/git/loader.py --- a/swh/loader/git/loader.py +++ b/swh/loader/git/loader.py @@ -497,6 +497,9 @@ level=logging.DEBUG, format="%(asctime)s %(process)d %(message)s" ) + from deprecated import deprecated + + @deprecated(version="1.1", reason="Use `swh loader run git --help` instead") @click.command() @click.option("--origin-url", help="Origin url", required=True) @click.option("--base-url", default=None, help="Optional Base url")