Skip to content

Commit afeee94

Browse files
Staudeyjoebonrichie
authored andcommitted
package.yml: fix first table format and link to CONFOPTS
Signed-off-by: Thomas Staudinger <Staudi.Kaos@gmail.com>
1 parent e18cfb5 commit afeee94

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/packaging/package.yml.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Package YAML
33
summary: Learning the package.yml packaging format
4-
date: 2022-12-16
4+
date: 2023-05-22
55
---
66

77
# Package.yml
@@ -49,12 +49,12 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below
4949
### Mandatory Keys
5050

5151
| Key Name | Type | Description |
52-
| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
52+
| --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5353
| **name** | `string` | The name of the package. This is also used as the base of all sub-package names. Unless unavoidable, this should match the upstream name. |
5454
| **version** | `string` | The version of the currently packaged software. This is taken from the tarball in most cases. |
5555
| **release** | `integer` | Specifies the current release number. Updates in the package number are based on this `release` number, _not_ the `version` number. As such, to release an update to users, this number must be incremented by one. |
5656
| **license** | `string(s)` | Valid upstream license(s). Try to ensure these use [SPDX identifiers](https://spdx.org/licenses/). |
57-
| **source** | `dict(s)` | Upstream source URL (i.e. tarball), with the valid `sha256sum` as a value. Alternatively, the git repository URL prefixed with `git | ` and a git tag or commit hash as a value. |
57+
| **source** | `dict(s)` | Upstream source URL (i.e. tarball), with the valid `sha256sum` as a value. Alternatively, the git repository URL prefixed with "git&#124;" and a git tag or commit hash as a value. |
5858
| **component** | `string` | Component / group of packages this package belongs to. Check available components via `eopkg lc` |
5959
| **summary** | `string` | Brief package summary, or display name. |
6060
| **description** | `string` | More extensive description of the software, usually taken from the vendor website. |
@@ -202,7 +202,7 @@ Macros are prefixed with `%`, and are substituted before your script is executed
202202
| **%ARCH%** | Indicates the current build architecture. |
203203
| **%CC%** | C compiler |
204204
| **%CFLAGS%** | cflags as set in `eopkg.conf` |
205-
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L376-378) |
205+
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/master/ypkg2/rc.yml#L353-L356) |
206206
| **%CXX%** | C++ compiler |
207207
| **%CXXFLAGS%** | cxxflags as set in `eopkg.conf` |
208208
| **%JOBS%** | jobs, as set in `eopkg.conf` |

0 commit comments

Comments
 (0)