diff --git a/docs/packaging/creating-a-new-package.md b/docs/packaging/creating-a-new-package.md index 5664fbc07..f7f2569fc 100644 --- a/docs/packaging/creating-a-new-package.md +++ b/docs/packaging/creating-a-new-package.md @@ -91,6 +91,7 @@ You can, of course, create your `package.yml` file entirely from scratch, but th Now you should have a `package.yml` file that looks something like this: + ```yaml name : unix-tree version : 2.1.1 @@ -125,6 +126,7 @@ For this example, we need to fix the following: After updating the file, it will now look like: + ```yaml name : tree version : 2.1.1 @@ -189,17 +191,17 @@ Here is an example in our standard format (make sure to check the box in the che ``` tree: initial inclusion in the repository -## Summary +**Summary** Add the tree package, which recursively lists directories in a tree like manner. -## Test Plan +**Test Plan** - Launched the application - Exercised the UI - Exercised some feature -## Checklist +**Checklist** - [] Package was built and tested against unstable ``` diff --git a/docs/packaging/packaging-practices.md b/docs/packaging/packaging-practices.md index 2f743a7ff..4e6864f4e 100644 --- a/docs/packaging/packaging-practices.md +++ b/docs/packaging/packaging-practices.md @@ -98,6 +98,7 @@ pkgconfig dependencies in alphabetical order explicitly named dependencies in alphabetical order Example: + ```yaml builddeps : - pkgconfig(ayatana-appindicator-0.1) @@ -169,9 +170,10 @@ pkgconfig(gtk+-wayland-3.0) pkgconfig(gtk+-x11-3.0) In the `builddeps` list, simply use the `pkgconfig(name)` syntax. For example, to add gtk+-3.0 to the build dependencies, we would do the following: + ```yaml builddeps: - - pkgconfig(gtk+-3.0) + - pkgconfig(gtk+-3.0) ``` At build time the appropriate provider package is selected, in this instance `libgtk-3-devel` @@ -185,9 +187,10 @@ Simply list the package name. When a `pkgconfig` dependency is available you will be asked to use that instead. ::: + ```yaml builddeps: - - stk-devel + - stk-devel ``` ## Runtime dependencies @@ -206,6 +209,7 @@ This key uses the `dict(s)` type, and the default key is the current package `na This would add the “python-gobject” runtime dependency to the main package: + ```yaml rundeps: - python-gobject @@ -213,6 +217,7 @@ rundeps: This would add the same dependency, as well as adding it to the `devel` subpackage: + ```yaml rundeps: - python-gobject @@ -221,6 +226,7 @@ rundeps: Remember this uses the `dict(s)` type, which is very flexible. You can equally express this as follows (adding more deps as an example): + ```yaml rundeps: - python-gobject