Distribution.SPDX.License

Cabal-2.4.0.1: A framework for packaging Haskell software

Safe Haskell | None
Language | Haskell2010

Distribution.SPDX.License

Synopsis

- data License
  - = NONE
  - | License LicenseExpression

# Documentation

data License #

Declared license. See section 3.15 of SPDX Specification 2.1

Note: the NOASSERTION case is omitted.

Old `License` can be migrated using following rules:

- `AllRightsReserved` and `UnspecifiedLicense` to `NONE`. No license specified which legally defaults to All Rights Reserved. The package may not be legally modified or redistributed by anyone but the rightsholder.
- `OtherLicense` can be converted to `LicenseRef` pointing to the file in the package.
- `UnknownLicense` i.e. other licenses of the form `name-x.y`, should be covered by SPDX license list, otherwise use `LicenseRef`.
- `PublicDomain` isn't covered. Consider using CC0. See https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files for more information.

Constructors

NONE | if the package contains no license information whatsoever; or
License LicenseExpression | A valid SPDX License Expression as defined in Appendix IV.

Instances

Eq License # |
Instance details Defined in Distribution.SPDX.License Methods (==) :: License -> License -> Bool # (/=) :: License -> License -> Bool #
Data License # |
Instance details Defined in Distribution.SPDX.License Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> License -> c License Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c License Source # toConstr :: License -> Constr Source # dataTypeOf :: License -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c License) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c License) Source # gmapT :: (forall b. Data b => b -> b) -> License -> License Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> License -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> License -> r Source # gmapQ :: (forall d. Data d => d -> u) -> License -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> License -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> License -> m License Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> License -> m License Source #
Ord License # |
Instance details Defined in Distribution.SPDX.License Methods compare :: License -> License -> Ordering # (<) :: License -> License -> Bool # (<=) :: License -> License -> Bool # (>) :: License -> License -> Bool # (>=) :: License -> License -> Bool # max :: License -> License -> License # min :: License -> License -> License #
Read License # |
Instance details Defined in Distribution.SPDX.License Methods readsPrec :: Int -> ReadS License Source # readList :: ReadS [License] Source # readPrec :: ReadPrec License Source # readListPrec :: ReadPrec [License] Source #
Show License # |
Instance details Defined in Distribution.SPDX.License Methods showsPrec :: Int -> License -> ShowS Source # show :: License -> String Source # showList :: [License] -> ShowS Source #
Generic License # |
Instance details Defined in Distribution.SPDX.License Associated Types type Rep License :: Type -> Type Source # Methods from :: License -> Rep License x Source # to :: Rep License x -> License Source #
Binary License # |
Instance details Defined in Distribution.SPDX.License Methods put :: License -> Put Source # get :: Get License Source # putList :: [License] -> Put Source #
NFData License # |
Instance details Defined in Distribution.SPDX.License Methods rnf :: License -> () Source #
Pretty License # |
Instance details Defined in Distribution.SPDX.License Methods pretty :: License -> Doc #
Parsec License # |
    >>> eitherParsec "BSD-3-Clause AND MIT" :: Either String License
    Right (License (EAnd (ELicense (ELicenseId BSD_3_Clause) Nothing) (ELicense (ELicenseId MIT) Nothing)))
    >>> eitherParsec "NONE" :: Either String License
    Right NONE
Instance details Defined in Distribution.SPDX.License Methods parsec :: CabalParsing m => m License #
Newtype SpecLicense (Either License License) # |
Instance details Defined in Distribution.Parsec.Newtypes Methods pack :: Either License0 License -> SpecLicense # unpack :: SpecLicense -> Either License0 License #
type Rep License # |
Instance details Defined in Distribution.SPDX.License type Rep License = D1 (MetaData "License" "Distribution.SPDX.License" "Cabal-2.4.0.1" False) (C1 (MetaCons "NONE" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "License" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LicenseExpression)))