From 84a67f9bc76b61789e97abbcc0469e86db869402 Mon Sep 17 00:00:00 2001 From: David Harder Date: Wed, 6 Nov 2024 10:18:02 -0600 Subject: [PATCH] Run prettier --- docs/packaging/appstream-metainfo.md | 19 +++++---- docs/packaging/package.yml.md | 42 ++++++++++---------- i18n/en/docusaurus-theme-classic/footer.json | 2 +- 3 files changed, 31 insertions(+), 32 deletions(-) diff --git a/docs/packaging/appstream-metainfo.md b/docs/packaging/appstream-metainfo.md index 7ccbcfa0b..2e1e95fcb 100644 --- a/docs/packaging/appstream-metainfo.md +++ b/docs/packaging/appstream-metainfo.md @@ -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. diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md index e8f5a675f..39dbd0e9e 100644 --- a/docs/packaging/package.yml.md +++ b/docs/packaging/package.yml.md @@ -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 diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index 72f1555ed..2dd1f6d18 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -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" },