Skip to content

Commit

Permalink
package.yml.md: Reorder table to match example file
Browse files Browse the repository at this point in the history
Reorder the Mandatory keys table to be in the same order as the corresponding lines in the example file
  • Loading branch information
johnandmegh authored Jan 15, 2024
1 parent 164a00c commit 999377e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/packaging/package.yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Not all fields in `package.yml` are mandatory, but a small selection are. Below
| **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. |
| **version** | `string` | The version of the currently packaged software. This is taken from the tarball in most cases. |
| **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. |
| **license** | `string(s)` | Valid upstream license(s). Try to ensure these use [SPDX identifiers](https://spdx.org/licenses/). |
| **homepage** | `string` | Provides a link to the package's homepage, used in the Software Center. |
| **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. |
| **component** | `string` | Component / group of packages this package belongs to. Check available components via `eopkg lc`. |
| **homepage** | `string` | Provides a link to the package's homepage, used in the Software Center. |
| **license** | `string(s)` | Valid upstream license(s). Try to ensure these use [SPDX identifiers](https://spdx.org/licenses/). |
| **summary** | `string` | Brief package summary, or display name. |
| **component** | `string` | Component / group of packages this package belongs to. Check available components via `eopkg lc`. |
| **description** | `string` | More extensive description of the software, usually taken from the vendor website. |

### Optional, supported keys
Expand Down

0 comments on commit 999377e

Please sign in to comment.