Skip to content

Commit

Permalink
Run prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidjharder
davidjharder committed Nov 6, 2024
1 parent 2e0afb8 commit 84a67f9
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 32 deletions.
19 changes: 9 additions & 10 deletions docs/packaging/appstream-metainfo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,15 @@ AppStream metainfo become a requirement for all graphical application in Solus r

There are a few scenarios that Packagers might encounter:

|No | Scenario |Solution |
| -------- | --------------------------------- | -----------|
| 1 | An application already provides appstream metainfo| Nothing to do|
|2| An application contains appstream metainfo in the source package but we do not install it | Install the appstream metainfo to `/usr/share/metainfo`. _Example_: [here](https://github.com/getsolus/packages/commit/0a726a53454e7c8a6b0e66de69d59bcc66f0fc19 )|
|3| An application doesn't contain appstream metainfo in the source package but it exists on Flathub | Borrow and tweak the appstream metainfo from the Flathub repo. Encourage upstream project to add it to their source. _Example_: [here](https://github.com/getsolus/packages/commit/da2f65b93f412da43d1db9edbcb08bb90517a0eb)|
|4| An application doesn't provide appstream metainfo and it doesn't exist on flathub| Write the appstream metadata, submit it to upstream project. _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4)|
| 5 |Appstream metainfo is provided but generation of it is failing| See [here](https://github.com/getsolus/solus-appstream-data#debugging-failures). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5).|


AppStream metainfo is to be installed in the `/usr/share/metainfo/` directory. It must be placed in the package which should be installed in order to get the software described by the respective metadata. This means that you might need to move the *.metainfo.xml or *.appdata.xml to the right (sub)package.
| No | Scenario | Solution |
| --- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1 | An application already provides appstream metainfo | Nothing to do |
| 2 | An application contains appstream metainfo in the source package but we do not install it | Install the appstream metainfo to `/usr/share/metainfo`. _Example_: [here](https://github.com/getsolus/packages/commit/0a726a53454e7c8a6b0e66de69d59bcc66f0fc19) |
| 3 | An application doesn't contain appstream metainfo in the source package but it exists on Flathub | Borrow and tweak the appstream metainfo from the Flathub repo. Encourage upstream project to add it to their source. _Example_: [here](https://github.com/getsolus/packages/commit/da2f65b93f412da43d1db9edbcb08bb90517a0eb) |
| 4 | An application doesn't provide appstream metainfo and it doesn't exist on flathub | Write the appstream metadata, submit it to upstream project. _Example_: [here](https://github.com/getsolus/packages/commit/414219d8b2ceeabe85178d3a467f81b9131016f4) |
| 5 | Appstream metainfo is provided but generation of it is failing | See [here](https://github.com/getsolus/solus-appstream-data#debugging-failures). _Example_: [here](https://github.com/getsolus/packages/commit/583b7c742caf50e2f66a70e9b62e9b91566c03f5). |

AppStream metainfo is to be installed in the `/usr/share/metainfo/` directory. It must be placed in the package which should be installed in order to get the software described by the respective metadata. This means that you might need to move the _.metainfo.xml or _.appdata.xml to the right (sub)package.

In case your AppStream metainfo is describing a desktop-application (you can tell by the XML root-node having a type="desktop-application" or type="desktop" attribute), the .appdata.xml file must be placed in the same package as the .desktop file already is, which (as above) must be the package containing the application itself.

Expand Down
42 changes: 21 additions & 21 deletions docs/packaging/package.yml.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,27 +252,27 @@ BOLT is a post-link optimizer developed to speed up large applications. You will

### Variable macros

| Macro | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **%ARCH%** | Indicates the current build architecture. |
| **%CC%** | C compiler. |
| **%CFLAGS%** | cflags as set in `eopkg.conf`. |
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/v33/ypkg2/rc.yml#L446-L458) |
| **%CXX%** | C++ compiler. |
| **%CXXFLAGS%** | cxxflags as set in `eopkg.conf`. |
| **%JOBS%** | jobs, as set in `eopkg.conf`. |
| **%LDFLAGS%** | ldflags as set in `eopkg.conf`. |
| **%LIBSUFFIX%** | Library suffix (either 32 for 32-bit or 64 for 64-bit). |
| **%PREFIX%** | Hard-coded prefix `/usr`. |
| **%YJOBS%** | Job count without `-j` as set in `eopkg.conf`. |
| **%installroot%** | Hard-coded install directory. |
| **%libdir%** | The distribution’s default library directory, i.e. `/usr/lib64` (Alters for `emul32`). |
| **%version%** | Version of the package, as specified in the `version` key. |
| **%workdir%** | Hard-coded work directory (source tree). |
| **%kernel_version_lts%** | Version of the `linux-lts` kernel. |
| **%kernel_version_current%** | Version of the `linux-current` kernel. |
| **%python2_version%** | Version of the `python` (Python 2) distribution. |
| **%python3_version%** | Version of the `python3` distribution. |
| Macro | Description |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **%ARCH%** | Indicates the current build architecture. |
| **%CC%** | C compiler. |
| **%CFLAGS%** | cflags as set in `eopkg.conf`. |
| **%CONFOPTS%** | Flags / options for configuration, such as `--prefix=%PREFIX%`. [Full List.](https://github.com/getsolus/ypkg/blob/v33/ypkg2/rc.yml#L446-L458) |
| **%CXX%** | C++ compiler. |
| **%CXXFLAGS%** | cxxflags as set in `eopkg.conf`. |
| **%JOBS%** | jobs, as set in `eopkg.conf`. |
| **%LDFLAGS%** | ldflags as set in `eopkg.conf`. |
| **%LIBSUFFIX%** | Library suffix (either 32 for 32-bit or 64 for 64-bit). |
| **%PREFIX%** | Hard-coded prefix `/usr`. |
| **%YJOBS%** | Job count without `-j` as set in `eopkg.conf`. |
| **%installroot%** | Hard-coded install directory. |
| **%libdir%** | The distribution’s default library directory, i.e. `/usr/lib64` (Alters for `emul32`). |
| **%version%** | Version of the package, as specified in the `version` key. |
| **%workdir%** | Hard-coded work directory (source tree). |
| **%kernel_version_lts%** | Version of the `linux-lts` kernel. |
| **%kernel_version_current%** | Version of the `linux-current` kernel. |
| **%python2_version%** | Version of the `python` (Python 2) distribution. |
| **%python3_version%** | Version of the `python3` distribution. |

## Variables

Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-theme-classic/footer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
"message": "Issue Tracker",
"description": "The label of footer link with label=Issue Tracker linking to https://issues.getsol.us"
},
"link.item.label.Security": {
"link.item.label.Security": {
"message": "Security",
"description": "The label of footer link with label=Security linking to https://github.com/getsolus/packages/blob/main/SECURITY.md"
},
Expand Down

0 comments on commit 84a67f9

Please sign in to comment.