object

registries

Registry handling predicates.

Author: Paulo Moura
Version: 0:50:1
Date: 2022-08-24
Compilation flags:
static, context_switching_calls
Imports:
public options
Uses:
Remarks:
(none)

Public predicates

list/0

Prints a list of all defined registries, including how defined (git, archive, or directory) and if they are pinned.

Compilation flags:
static
Mode and number of proofs:
list - one

describe/1

Prints all registry entries.

Compilation flags:
static
Template:
describe(Registry)
Mode and number of proofs:
describe(+atom) - one

defined/4

Enumerates by backtracking all defined registries, their definition URL, how they are defined (git, archive, or directory), and if they are pinned.

Compilation flags:
static
Template:
defined(Registry,URL,HowDefined,Pinned)
Mode and number of proofs:
defined(?atom,?atom,?atom,?boolean) - zero_or_more

add/3

Adds a new registry using the given options. Fails if the registry cannot be added or if it is already defined. HTTPS URLs must end with either a .git extension or a an archive extension. A file:// URL can be used for a local directory.

Compilation flags:
static
Template:
add(Registry,URL,Options)
Mode and number of proofs:
add(+atom,+atom,++list(compound)) - zero_or_one
Remarks:
  • Registry name: Must be the URL basename when using a git URL or a local directory URL. Must also be the declared registry name in the registry specification object.

  • force(Boolean) option: Force re-installation if the registry is already defined. Default is false.

  • clean(Boolean) option: Clean registry archive after updating. Default is false.

  • verbose(Boolean) option: Verbose adding steps. Default is false.

  • curl(Atom) option: Extra command-line options. Default is ''.

  • gpg(Atom) option: Extra command-line options. Default is ''.

  • tar(Atom) option: Extra command-line options. Default is ''.


add/2

Adds a new registry using default options. Fails if the registry cannot be added or if it is already defined. HTTPS URLs must end with either a .git extension or a an archive extension. A file:// URL can be used for a local directory.

Compilation flags:
static
Template:
add(Registry,URL)
Mode and number of proofs:
add(+atom,+atom) - zero_or_one
Remarks:
  • Registry name: Must be the URL basename when using a git URL or a local directory URL. Must also be the declared registry name in the registry specification object.


add/1

Adds a new registry from a git cloning or local directory URL using default options. Fails if the registry cannot be added or if it is already defined. HTTPS URLs must end with a .git extension. A file:// URL can be used for a local directory.

Compilation flags:
static
Template:
add(URL)
Mode and number of proofs:
add(+atom) - zero_or_one
Remarks:
  • Limitations: Cannot be used for archive download URLs.

  • Registry name: Taken from the URL basename.


update/2

Updates a defined registry using the specified options. Fails if the registry is not defined.

Compilation flags:
static
Template:
update(Registry,Options)
Mode and number of proofs:
update(+atom,++list(compound)) - zero_or_one
Remarks:
  • force(Boolean) option: Force update if the registry is pinned. Default is false.

  • clean(Boolean) option: Clean registry archive after updating. Default is false.

  • verbose(Boolean) option: Verbose updating steps. Default is false.

  • curl(Atom) option: Extra command-line options. Default is ''.

  • gpg(Atom) option: Extra command-line options. Default is ''.

  • tar(Atom) option: Extra command-line options. Default is ''.


update/1

Updates a defined registry using default options. Fails if the registry is not defined.

Compilation flags:
static
Template:
update(Registry)
Mode and number of proofs:
update(+atom) - zero_or_one

update/0

Updates all defined registries using default options.

Compilation flags:
static
Mode and number of proofs:
update - zero_or_one

delete/2

Deletes a registry using the specified options (if not pinned).

Compilation flags:
static
Template:
delete(Registry,Options)
Mode and number of proofs:
delete(+atom,++list(compound)) - zero_or_one
Remarks:
  • force(Boolean) option: Force deletion if the registry is pinned or there are installed registry packs. Default is false.

  • clean(Boolean) option: Clean registry archive after deleting. Default is false.

  • verbose(Boolean) option: Verbose deleting steps. Default is false.

  • curl(Atom) option: Extra command-line options. Default is ''.

  • gpg(Atom) option: Extra command-line options. Default is ''.

  • tar(Atom) option: Extra command-line options. Default is ''.


delete/1

Deletes a registry using default options.

Compilation flags:
static
Template:
delete(Registry)
Mode and number of proofs:
delete(+atom) - zero_or_one

delete/0

Deletes all registries using the force(true) option.

Compilation flags:
static
Mode and number of proofs:
delete - zero_or_one

clean/1

Cleans all registry archives. Fails if the registry is not defined.

Compilation flags:
static
Template:
clean(Registry)
Mode and number of proofs:
clean(+atom) - zero_or_one

clean/0

Cleans all archives for all registries.

Compilation flags:
static
Mode and number of proofs:
clean - one

provides/2

Enumerates by backtracking all packs provided by a registry.

Compilation flags:
static
Template:
provides(Registry,Pack)
Mode and number of proofs:
provides(?atom,?atom) - zero_or_more

lint/1

Checks the registry specification. Fails if the registry is not defined or if linting detects errors.

Compilation flags:
static
Template:
lint(Registry)
Mode and number of proofs:
lint(+atom) - zero_or_one

lint/0

Checks all registry specifications.

Compilation flags:
static
Mode and number of proofs:
lint - one

Protected predicates

(no local declarations; see entity ancestors if any)

Private predicates

(no local declarations; see entity ancestors if any)

Operators

(none)