Snippets Groups Projects

Forked from Platform / Development / swh-model

223 commits behind the upstream repository.

4 years ago

identifiers: Rename some functions and types related to SWHIDs · 1ff05161

Antoine Lambert authored 4 years ago

When Software Heritage persistent identifiers were introduced, they were not
yet abbreviated as SWHIDs.

Now that abbreviation is growing adoption, rename some functions and types in
swh.model.identifiers for consistency:

  - PersistentId -> SWHID

  - persistent_identifier -> swhid

  - parse_persistent_identifier -> parse_swhid

Backward compatibility with previous naming is maintained but deprecation
warnings are introduced to encourage the use of the new names.

Numerous variables in swh.model codebase have also been renamed accordingly.

Also rework and improve documentation.

1ff05161

identifiers: Rename some functions and types related to SWHIDs

Antoine Lambert authored 4 years ago

When Software Heritage persistent identifiers were introduced, they were not
yet abbreviated as SWHIDs.

Now that abbreviation is growing adoption, rename some functions and types in
swh.model.identifiers for consistency:

  - PersistentId -> SWHID

  - persistent_identifier -> swhid

  - parse_persistent_identifier -> parse_swhid

Backward compatibility with previous naming is maintained but deprecation
warnings are introduced to encourage the use of the new names.

Numerous variables in swh.model codebase have also been renamed accordingly.

Also rework and improve documentation.

README.md 620 B

swh-model

Implementation of the Data model of the Software Heritage project, used to archive source code artifacts.

This module defines the notion of SoftWare Heritage persistent IDentifiers (SWHIDs) and provides tools to compute them:

   $ swh-identify fork.c kmod.c sched/deadline.c
   swh:1:cnt:2e391c754ae730bd2d8520c2ab497c403220c6e3    fork.c
   swh:1:cnt:0277d1216f80ae1adeed84a686ed34c9b2931fc2    kmod.c
   swh:1:cnt:57b939c81bce5d06fa587df8915f05affbe22b82    sched/deadline.c

   $ swh-identify --no-filename /usr/src/linux/kernel/
   swh:1:dir:f9f858a48d663b3809c9e2f336412717496202ab