Skip to content

Commit

Permalink
Document binary origins
Browse files Browse the repository at this point in the history
  • Loading branch information
mosteo committed Jan 25, 2024
1 parent 9932580 commit 0917ba4
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/catalog-format-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,12 @@ static, i.e. they cannot depend on the context.
several crates from the same repository (sometimes referred to as a
*monorepo*).

- `binary`: optional (defauts to false) boolean used to design the origin
as binary. Binary origins are not compiled and can use dynamic
expressions to narrow down the platform to which they apply. An origin
using a dynamic expression is implicitly tagged as binary; see the
example below.

Examples of origin tables:

```toml
Expand All @@ -479,6 +485,13 @@ static, i.e. they cannot depend on the context.
subdir = "examples"
```

```toml
# A binary origin denoting a compiler
[origin."case(os)".linux."case(host-arch)".x86-64]
url = "https://github.com/alire-project/GNAT-FSF-builds/releases/download/gnat-12.1.0-1/gnat-x86_64-linux-12.1.0-1.tar.gz"
hashes = ["sha256:df1f36b306359d528799b1de8629a793523347a90c9d4b72efd23c62a7279555"]
```

- `available`: optional dynamic boolean expression. If it evaluates to
`false`, the package is not available for the current platform.

Expand Down

0 comments on commit 0917ba4

Please sign in to comment.