Skip to main content

Browse the archive

Revision 1ff05161e795a71bf823f55c7d043cf9eaaa1d01 authored by Antoine Lambert on 03 July 2020, 10:18:38 UTC, committed by Antoine Lambert on 03 July 2020, 12:11:32 UTC 
identifiers: Rename some functions and types related to SWHIDs
 
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.
1 parent 8863b5c
Raw File
README.md 
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:

```sh
   $ 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
```
back to top