Skip to content

Commit

Permalink
Run prettier on everything (#422)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjharder authored Oct 26, 2023
1 parent e66e27e commit 5b844df
Show file tree
Hide file tree
Showing 24 changed files with 160 additions and 131 deletions.
10 changes: 5 additions & 5 deletions docs/packaging/advanced-config/eopkg-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Once the file has been copied, you can edit it with your text editor of choice.

Most keys in the config you'll probably want to leave untouched. However, some are useful to know about:

| Key | Description | Values |
| -------------------------------------------------------------------------------- | ------------- |
| generateDebug | Whether or not debug symbol subpackages will be generated | True / False |
| jobs | How many building jobs to use when compiling the source | auto / number |
| retry_attempts | How many times to retry downloading a package during install | number |
| Key | Description | Values |
| -------------- | ------------------------------------------------------------ | ------------- |
| generateDebug | Whether or not debug symbol subpackages will be generated | True / False |
| jobs | How many building jobs to use when compiling the source | auto / number |
| retry_attempts | How many times to retry downloading a package during install | number |

## Restoring defaults

Expand Down
2 changes: 1 addition & 1 deletion docs/packaging/creating-a-new-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page will take you through the steps required to build a new package for th

:::note

**Please [look to see if an issue has been filed](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) and *accepted* for the software or library you intend to package**. If there is an existing request, please add a link to it in your pull request. Ex:
**Please [look to see if an issue has been filed](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) and _accepted_ for the software or library you intend to package**. If there is an existing request, please add a link to it in your pull request. Ex:

```
This PR resolves software request https://github.com/getsolus/packages/issues/123
Expand Down
8 changes: 5 additions & 3 deletions docs/packaging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ Please check the following:

1. [Update your development environment](update-dev-environment.md)
2. Prepare the package directory and build the package
* For a new package that does not yet exist in the repos see [Creating a New Package](creating-a-new-package.md)
* For updating a package that already is in the repos see [Updating an Existing Package](updating-an-existing-package.md)

- For a new package that does not yet exist in the repos see [Creating a New Package](creating-a-new-package.md)
- For updating a package that already is in the repos see [Updating an Existing Package](updating-an-existing-package.md)

3. [Test the Package](testing-a-package.md)
4. [Submit a Pull Request for Review](submitting-a-pull-request.md)
4. [Submit a Pull Request for Review](submitting-a-pull-request.md)
3 changes: 3 additions & 0 deletions docs/packaging/packaging-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,12 @@ All new packages or updates to packages should abide by the [SPDX 3.x](https://s

:::note
Build dependencies should be ordered according to the following rules in `package.yml`:

1. `pkgconfig` dependencies before explicitly named dependencies
2. Each of these two groups in so-called ASCIIbetical order (that is, alphabetical order with all uppercase letters before lowercase letters, and digits/punctuation before letters, [see here](https://en.wikipedia.org/wiki/ASCII#Character_order))

Example:

<!-- prettier-ignore -->
```yaml
builddeps :
Expand All @@ -113,6 +115,7 @@ builddeps :
- python-poetry
- swig
```
:::
### Background
Expand Down
14 changes: 7 additions & 7 deletions docs/packaging/prepare-for-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,13 @@ ln -s ~/solus-packages/common/Scripts/helpers.zsh ~/.zshrc.d/solus-monorepo-help

You should now have the following available from your shell:

| Function | Description | Usage |
| ----------------- | -------------------------------------------------------------------------------------------------- | ---------- |
| **gotosoluspkgs** | Change directory to the solus monorepo from anywhere on the filesystem. | `gotosoluspkgs`
| **goroot** | When in the solus monorepo, change directory to the root directory of the git repository. | `goroot`
| **gotopkg** | Change directory to any solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox`
| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1`
| **whatprovides** | Find out what package provides a library by reading the `abi_libs` files. | `whatprovides libfoobar.so.1.`
| Function | Description | Usage |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| **gotosoluspkgs** | Change directory to the solus monorepo from anywhere on the filesystem. | `gotosoluspkgs` |
| **goroot** | When in the solus monorepo, change directory to the root directory of the git repository. | `goroot` |
| **gotopkg** | Change directory to any solus package. You can type part of the package name then double press `Tab` to get autocompletion for this function. | `gotopkg firefox` |
| **whatuses** | Find out what packages use a library by reading the `abi_used_libs` files. | `whatuses libfoobar.so.1` |
| **whatprovides** | Find out what package provides a library by reading the `abi_libs` files. | `whatprovides libfoobar.so.1.` |

## Building Packages

Expand Down
2 changes: 1 addition & 1 deletion docs/packaging/procedures/maintainership.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ This file is used to indicate primary maintainership for this package. A package
- Name Surname
- Matrix: REPLACEME
- Email: REPLACEME
```
```
2 changes: 1 addition & 1 deletion docs/packaging/procedures/request-a-package-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ You will be asked in the form to provide the following information:
- Description: Explanation as to the value-add of updating this package.
- Link to source tarball/zip file. Note: master.zip files **are not permitted**. We require versioned tarballs, for example: "1.2.3.tar.gz".

Please put this into a new [issue](https://github.com/getsolus/packages/issues/new?assignees=&labels=Package+Request&projects=&template=request-package-update.yaml).
Please put this into a new [issue](https://github.com/getsolus/packages/issues/new?assignees=&labels=Package+Request&projects=&template=request-package-update.yaml).
2 changes: 1 addition & 1 deletion docs/packaging/submitting-a-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Please refrain from submitting a pull request for the following instances:

- For a package that is yet to be accepted for inclusion by a member of the Solus Staff team. Search [open package requests](https://github.com/getsolus/packages/issues?q=label%3A%22Package+Request%22) to see if there is an open request for the package.
We welcome you to politely reach out via the package request issue or our Support room on [Matrix](/docs/user/contributing/getting-involved#matrix-chat) if you deem the review of the request to be time-sensitive in nature.
- If your pull request is a Work In Progress / WIP. Pull requests that are completed or are marked as *request for comments* (RFC) are accepted. For RFC request please ensure your patch title contains `[RFC]` and is marked as 'draft'. WIP patches clutter the issue tracker and make patch review by Solus Staff more time consuming and introduces unnecessary work.
- If your pull request is a Work In Progress / WIP. Pull requests that are completed or are marked as _request for comments_ (RFC) are accepted. For RFC request please ensure your patch title contains `[RFC]` and is marked as 'draft'. WIP patches clutter the issue tracker and make patch review by Solus Staff more time consuming and introduces unnecessary work.

## Final Branch Review

Expand Down
2 changes: 1 addition & 1 deletion docs/packaging/testing-a-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ After building a package, it must be tested against the unstable repo before a p
You will use the .eopkg file(s) created by the build process for testing.

## Install the `.eopkg` Files

To install your new package, run the following command in the directory where you built the package. Include **all** `.eopkg` files that were built.

```bash
Expand Down Expand Up @@ -38,4 +39,3 @@ To remove these files, run:
```bash
go-task clean
```

1 change: 1 addition & 0 deletions docs/packaging/your-first-package-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Switch to the directory containing the `nano` recipe:
```bash
cd packages/n/nano
```

Alternatively, if you've set up the [Monorepo Helper Functions](docs/packaging/prepare-for-packaging#set-up-monorepo-helper-functions-optional) you can replace the above to steps by these simple commands:

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/user/contributing/testing-an-iso.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ When testing, try to keep different types of users in mind. For instance, would

This functionality might be affected by the settings of the VM.

- Copy and paste works from host to guest *before* install, while booted into the live ISO
- Copy and paste works *after* installation and rebooting the VM
- Copy and paste works from host to guest _before_ install, while booted into the live ISO
- Copy and paste works _after_ installation and rebooting the VM

## For the specific release

Expand Down
Loading

0 comments on commit 5b844df

Please sign in to comment.