Skip to content

Commit

Permalink
Re-organize repo-management.md
Browse files Browse the repository at this point in the history 
- Apply the style guide to the topic.
- Re-organize the topic for better scannability.
  • Loading branch information
@deoxys94
deoxys94 committed Aug 12, 2024
1 parent e47bd82 commit e25814a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 96 deletions.
18 changes: 9 additions & 9 deletions docs/user/package-management/basics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Solus uses the eopkg package manager. You can use `eopkg` to install, update, an

The following table lists the most common `eopkg` commands:

| Task | Command | Example |
| ------------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------ |
| Install software | `sudo eopkg install PACKAGE_NAME` | `sudo eopkg install gnome-documents gnome-music` |
| Reinstall software | `sudo eopkg install --reinstall PACKAGE_NAME` | `sudo eopkg install --reinstall gnome-documents gnome-music` |
| Uninstall software | `sudo eopkg remove PACKAGE_NAME` | `sudo eopkg remove gnome-documents gnome-music` |
| Update your system | `sudo eopkg upgrade` | - |
| Update specific software | `sudo eopkg upgrade PACKAGE_NAME` | `sudo eopkg upgrade firefox` |
| Search for software | `eopkg search KEYWORD` | `eopkg search documents` |
| Get information on software, such as description or version | `eopkg info PACKAGE_NAME` | `eopkg info gnome-documents` |
| Action | Command | Example |
| ----------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------ |
| Install software | `sudo eopkg install PACKAGE_NAME` | `sudo eopkg install gnome-documents gnome-music` |
| Reinstall software | `sudo eopkg install --reinstall PACKAGE_NAME` | `sudo eopkg install --reinstall gnome-documents gnome-music` |
| Uninstall software | `sudo eopkg remove PACKAGE_NAME` | `sudo eopkg remove gnome-documents gnome-music` |
| Update your system | `sudo eopkg upgrade` | - |
| Update specific software | `sudo eopkg upgrade PACKAGE_NAME` | `sudo eopkg upgrade firefox` |
| Search for software | `eopkg search KEYWORD` | `eopkg search documents` |
| Get information on software, such as description or version | `eopkg info PACKAGE_NAME` | `eopkg info gnome-documents` |
107 changes: 20 additions & 87 deletions docs/user/package-management/repo-management.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,103 +3,36 @@ title: Repository Management
summary: Repository Management
---

# Repository Management
# Repository management

While Solus currently only provides two repositories, stable (shannon) and unstable, our package manager does support actively using multiple repositories on your system. This is useful if you are using a vendor-provided repository.
Solus offers two main software sources: stable (shannon) and unstable. The `eopkg` package manager can use multiple sources on your system, which is helpful if you use a source provided by another vendor.

## Official Solus repositories
## Official repositories

The official Solus repositories are:

| Repository | URL | Notes |
| -------------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Stable (shannon)** | `https://cdn.getsol.us/repo/shannon/eopkg-index.xml.xz` | This is the default repository. |
| **Unstable** | `https://cdn.getsol.us/repo/unstable/eopkg-index.xml.xz` | This repository should only be used if you intend to build Solus packages or to test new packages before they are synced to the _stable_ repository. |
| Repository | URL | Notes |
| ---------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| Stable (shannon) | `https://cdn.getsol.us/repo/shannon/eopkg-index.xml.xz` | Default software source. |
| Unstable | `https://cdn.getsol.us/repo/unstable/eopkg-index.xml.xz` | Only use this source if build Solus packages or you test new software before it moves to the stable source. |

:::danger

It is not always safe to perform a system update when using the **unstable** repository. Always check the topic of the [#solus-packaging](https://matrix.to/#/#solus-packaging:matrix.org) Matrix room before updating.
Updating your system while using the **unstable** source might be risky.

:::

## Adding a repository

You can add a repository by using:

```bash
sudo eopkg add-repo Name URL
```

For example:

```bash
sudo eopkg add-repo Example https://example.com/repo/eopkg-index.xml.xz
```

**Note:** This does not enable the repository.

## Removing a repository

You can remove a repository by using:

```bash
sudo eopkg remove-repo Name
```

For example:

```bash
sudo eopkg remove-repo Example
```

## Enabling a repository

You can enable a repository for usage, by using:
Before updating, check the [#solus-packaging](https://matrix.to/#/#solus-packaging:matrix.org) Matrix room.

```bash
sudo eopkg enable-repo Name
```

For example:

```bash
sudo eopkg enable-repo Example
```

## Disabling a repository

You can disable a repository by using:

```bash
sudo eopkg disable-repo Name
```

For example:

```bash
sudo eopkg disable-repo Example
```

## Updating a repository

You can update the index of a repository by using:

```bash
sudo eopkg update-repo Name
```

For example:

```bash
sudo eopkg update-repo Example
```

**Note:** You can update all repositories by **not** providing a name.
:::

## List repositories
## Repository management commands

You can list all the repositories added on your system by using:
The following table lists the `eopkg` commands you can use to manage your software sources.

```bash
eopkg list-repo
```
| Action | Command | Example | Notes |
| -------------------------------------- | ------------------------------ | ------------------------------------------------------------------------- | -------------------------------------------------------- |
| Add a repository | `sudo eopkg add-repo Name URL` | `sudo eopkg add-repo Example https://example.com/repo/eopkg-index.xml.xz` | This doesn't enable the repository. |
| Remove a repository | `sudo eopkg remove-repo Name` | `sudo eopkg remove-repo Example` | - |
| Enable a repository | `sudo eopkg enable-repo Name` | `sudo eopkg enable-repo Example` | - |
| Disable a repository | `sudo eopkg disable-repo Name` | `sudo eopkg disable-repo Example` | - |
| Update a repository | `sudo eopkg update-repo Name` | `sudo eopkg update-repo Example` | You can update all repositories by not providing a name. |
| List repositories added to your system | `eopkg list-repo` | `eopkg list-repo` | - |

0 comments on commit e25814a

Please sign in to comment.