Liking cljdoc? Tell your friends :D

spdx.impl.replacements

Functionality related to replacing certain ids with equivalents. Note: this namespace is not part of the public API of clj-spdx and may change without notice.

Functionality related to replacing certain ids with equivalents. Note: this
namespace is not part of the public API of clj-spdx and may change without
notice.
raw docstring

init!clj

(init!)

Initialises this namespace upon first call (and does nothing on subsequent calls), returning nil. Consumers of this namespace are not required to call this fn, as initialisation will occur implicitly anyway; it is provided to allow explicit control of the cost of initialisation to callers who need it.

Initialises this namespace upon first call (and does nothing on subsequent
calls), returning `nil`. Consumers of this namespace are not required to call
this fn, as initialisation will occur implicitly anyway; it is provided to
allow explicit control of the cost of initialisation to callers who need it.
sourceraw docstring

replacement-for-deprecated-exception-idclj

(replacement-for-deprecated-exception-id exception-id)

Returns the SPDX exception id that supercedes exception-id, if any. Returns nil if exception-id was nil, or if there is no replacement for exception-id (including the case where it's not deprecated).

Notes:

  • exception-id must be correctly cased as per the SPDX license exception list
  • Not all deprecated exception-ids have a replacement.
Returns the SPDX exception id that supercedes `exception-id`, if any.
Returns `nil` if `exception-id` was `nil`, or if there is no replacement for
`exception-id` (including the case where it's not deprecated).

Notes:

* `exception-id` _must_ be correctly cased as per the SPDX license exception
  list
* Not all deprecated `exception-id`s have a replacement.
sourceraw docstring

replacement-for-deprecated-license-idclj

(replacement-for-deprecated-license-id license-id or-later?)

Returns a map representing the replacement of license-id & or-later?, if any. Returns nil if license-id is nil, or if there is no replacement (including the case where it's not deprecated).

The map may contain any combination of these keys:

  • :license-ids - a sequence of replacement SPDX license ids
  • :license-exception-id - a single replacement SPDX license exception id
  • :or-later? - the or-later? flag, which may not be the same as the value passed in, depending on what's found

Notes:

  • license-id must be correctly cased as per the SPDX license list
  • Some deprecated SPDX license ids have been replaced with multiple license ids - in these cases this should be considered an AND
  • Not all deprecated license-ids have a replacement.
  • if or-later? is true, the or-later variant is first looked up, and then, if no result is found, the 'naked' identifier is also looked up
Returns a map representing the replacement of `license-id` & `or-later?`, if
any.  Returns `nil` if `license-id` is `nil`, or if there is no replacement
(including the case where it's not deprecated).

The map may contain any combination of these keys:

* `:license-ids` - a sequence of replacement SPDX license ids
* `:license-exception-id` - a single replacement SPDX license
   exception id
* `:or-later?` - the or-later? flag, which may not be the same as the value
  passed in, depending on what's found

Notes:

* `license-id` _must_ be correctly cased as per the SPDX license list
* Some deprecated SPDX license ids have been replaced with multiple
  license ids - in these cases this should be considered an `AND`
* Not all deprecated `license-id`s have a replacement.
* if or-later? is true, the or-later variant is first looked up, and then, if
  no result is found, the 'naked' identifier is also looked up
sourceraw docstring

replacement-for-license-idclj

(replacement-for-license-id license-id or-later?)

Returns a map representing the replacement of license-id & or-later?, if any. Returns nil if license-id is nil, or if there is no replacement.

The map may contain any combination of these keys:

  • :license-id - a replacement SPDX license id
  • :or-later? - the or-later? flag, which may not be the same as the value passed in, depending on what's found

Notes:

  • license-id must be correctly cased as per the SPDX license list
Returns a map representing the replacement of `license-id` & `or-later?`, if
any.  Returns `nil` if `license-id` is `nil`, or if there is no replacement.

The map may contain any combination of these keys:

* `:license-id` - a replacement SPDX license id
* `:or-later?` - the or-later? flag, which may not be the same as the value
  passed in, depending on what's found

Notes:

* `license-id` _must_ be correctly cased as per the SPDX license list
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close