Skip to content

Commit

Permalink
Cleanup for spelling and formatting
Browse files Browse the repository at this point in the history
- Run prettier
- Fix some spelllling
  • Loading branch information
davidjharder committed Jan 10, 2024
1 parent 9fa4674 commit 497d2cb
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 19 deletions.
18 changes: 9 additions & 9 deletions docs/packaging/package.yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ One or more optimize values can be specified in a list with the `optimize` key i

| Optimize Value | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| **speed** | Optimises the package for performance `-O3` plus other flags. |
| **size** | Optimises the package build to minimize size `-Os`. Not supported with clang. |
| **speed** | Optimizes the package for performance `-O3` plus other flags. |
| **size** | Optimizes the package build to minimize size `-Os`. Not supported with clang. |
| **no-bind-now** | Configures the package to disable certain flags, where RELRO is unsupported. |
| **no-symbolic** | Disables `-Wl,-Bsymbolic-functions` linker flag. |
| **unroll-loops** | Enables `-funroll-loops`. Use this sparingly, only when it provides proven benefit. |
Expand All @@ -110,7 +110,7 @@ One or more optimize values can be specified in a list with the `optimize` key i
| **icf-safe** | Enables safe Identical Cold Folding `--icf=safe`. `function-sections` is recommended when not using clang. Uses gold linker when not using clang. |
| **icf-all** | Enables Identical Cold Folding `--icf=all`. `function-sections` is recommended when not using clang. Uses gold linker when not using clang. |
| **polly** | Enables polyhedral optimizations for the clang toolchain. |
| **function-sections** | Generate a seperate ELF section for each function. Recommended with ICF when not using clang. |
| **function-sections** | Generate a separate ELF section for each function. Recommended with ICF when not using clang. |
| **no-reorder-blocks-partition** | Disables block partition reordering with the gcc toolchain. Provided to facilitate BOLT'ed binaries/libraries. |
| **emit-relocs** | Instructs the linker to emit relocations. Provided to facilitate BOLT'ed binaries/libraries. |

Expand Down Expand Up @@ -208,11 +208,11 @@ Macros are prefixed with `%`, and are substituted before your script is executed

BOLT is a post-link optimizer developed to speed up large applications. You will need to run a workload after instrumenting a binary or library. Think of it as post-link profile guided optimization.

| Macro | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **%bolt_instr** | Instrument a binary or library with llvm-bolt. Requires it to be built with `emit-relocs`, as well as `no-reorder-blocks-partition` if not using clang. |
| **%bolt_merge** | Merge fdata profiles into a single file after running a workload with a BOLT instrumented binary. |
| **%bolt_opt** | Optimize a binary using BOLT after running `%bolt_merge`. |
| Macro | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **%bolt_instr** | Instrument a binary or library with llvm-bolt. Requires it to be built with `emit-relocs`, as well as `no-reorder-blocks-partition` if not using clang. |
| **%bolt_merge** | Merge fdata profiles into a single file after running a workload with a BOLT instrumented binary. |
| **%bolt_opt** | Optimize a binary using BOLT after running `%bolt_merge`. |

### Variable Macros

Expand All @@ -239,7 +239,7 @@ BOLT is a post-link optimizer developed to speed up large applications. You will
A set of variables are exported in our build stages. These are used to provide context and structure to the scripts.

| Variable | Description |
| ---------------- | ------------------------------------------------------------------------------------------------ |
| ------------------ | ------------------------------------------------------------------------------------------------ |
| **$CFLAGS** | cflags as set in `eopkg.conf`. |
| **$CXXFLAGS** | cxxflags as set in `eopkg.conf`. |
| **$LDFLAGS** | ldflags as set in `eopkg.conf`. |
Expand Down
3 changes: 2 additions & 1 deletion docs/packaging/updating-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@ There should be a meaningful summary line (which starts with the package name),
`git commit` on [an initialized repository](prepare-for-packaging.md#initialize-git-hooks) will automatically open your editor with the correct template.
Note that lines starting with a `#` will be ignored by Git and do not need to be removed.

*Important*: Do not include issue numbers in changelogs. This will incorrectly link your issue to another one in our repository. Ex:
_Important_: Do not include issue numbers in changelogs. This will incorrectly link your issue to another one in our repository. Ex:

```
- #123 fixed a thing
```
Expand Down
1 change: 1 addition & 0 deletions docs/user/software/camera/droidcam.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ DroidCam can be installed from Software Center or via terminal :
```bash
sudo eopkg it droidcam
```

Once DroidCam is installed, reboot your system. Now DroidCam is ready to use.

## Usage
Expand Down
6 changes: 3 additions & 3 deletions docs/user/software/desktops/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ sudo eopkg install -c desktop.mate

## XFCE

Solus offers the XFCE desktop environment for users preferring a more lightweight experience. It is reccomended for existing MATE users. You can install XFCE with the following command:
Solus offers the XFCE desktop environment for users preferring a more lightweight experience. It is recommended for existing MATE users. You can install XFCE with the following command:

```
# Do NOT attempt to do this if you are running the KDE Plasma Desktop version of Solus!
sudo eopkg install -c desktop.xfce
```

### Tiling window manaagers
## Tiling window managers

### i3

Expand All @@ -73,5 +73,5 @@ sudo eopkg install sway
```

Sway expects users to do some configuration, refer to the [Sway Wiki](https://github.com/swaywm/sway/wiki).

For more information about tiling window managers, click [here](https:/en.wikipedia.org/wiki/Tiling_window_manager).
2 changes: 1 addition & 1 deletion docs/user/software/sound/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ summary: Configuration of sound systems on Solus

# Sound

Solus comes with Pipewire configured by default.
Solus comes with Pipewire configured by default.
3 changes: 1 addition & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const themes = require('prism-react-renderer').themes;
const themes = require("prism-react-renderer").themes;
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

Expand Down Expand Up @@ -165,7 +165,6 @@ const config = {
label: "Issue Tracker",
href: "https://issues.getsol.us",
},

],
},
],
Expand Down
4 changes: 3 additions & 1 deletion src/components/editions/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ const Editions = [
urlConfig: "xfce/configuration",
urlTips: "xfce/tips-and-tricks",
description: (
<Translate id="edition.xfce.description">A lightweight desktop that aims to be fast while still being friendly.</Translate>
<Translate id="edition.xfce.description">
A lightweight desktop that aims to be fast while still being friendly.
</Translate>
),
},
];
Expand Down
3 changes: 1 addition & 2 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}


/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
[data-theme="dark"] {
--ifm-color-primary: #5294e2;
--ifm-color-primary-dark: #3884de;
--ifm-color-primary-darker: #2a7cdb;
Expand Down

0 comments on commit 497d2cb

Please sign in to comment.