Repository navigation
Home
bs-updater updates all software on a Linux system with one command. It also supplies a tray widget for KDE Plasma. The widget shows how many updates are available.
This wiki is the technical paper for the project. Each page is one chapter. The chapters describe the purpose, the design, the installation, the configuration, the operation and the maintenance of bs-updater.
The text obeys ASD-STE100, Simplified Technical English, Issue 9. The specification supplies a set of writing rules and a dictionary of approved words. It also lets a project declare its own technical names and technical verbs. Chapter 13 gives the compliance statement and the declared words.
| Chapter | Page | Content |
|---|---|---|
| 1 | Introduction and scope | What the product does, and what it does not do. |
| 2 | System description | The two parts of the product and their tasks. |
| 3 | Update sources | The supported tools, the package domains and the conflict rule. |
| 4 | Installation | How to install, and what the installation script does. |
| 5 | Configuration | The settings pages and the configuration file. |
| 6 | Operation | The states of the widget, the icons and the notifications. |
| 7 | Command reference | Every option of bs-update, with the output format. |
| 8 | Architecture | The files, the data flow and the design decisions. |
| 9 | Distribution notes | Arch Linux, Fedora, Nobara, Debian and Ubuntu. |
| 10 | Verification | The test suite and what each group of tests proves. |
| 11 | The release procedure | How to build and publish a new version. |
| 12 | Fault isolation | Symptoms, causes and corrective actions. |
| 13 | Simplified Technical English | The compliance statement and the declared words. |
| 14 | Glossary | The terms that this paper uses. |
- If you are a user, read chapters 1, 4, 5, 6 and 9.
- If you are a maintainer, read chapters 2, 3, 8, 10 and 11.
- If you write text for this project, read chapters 13 and 14 first.
| Item | Value |
|---|---|
| Title | bs-updater technical paper |
| Product | bs-updater |
| Applicable product version | 1.10.0 |
| Language | Simplified Technical English, ASD-STE100 Issue 9 |
| License of the product | The Unlicense, public domain |
| Knowledge space | BUPI |
bs-updater technical paper — written in Simplified Technical English, ASD-STE100 Issue 9. See chapter 13.