Skip to content

Commit 2cb6d3e

Browse files
committed
README: fix TOC in main README
Signed-off-by: Douglas Landgraf <[email protected]>
1 parent a1c7f8d commit 2cb6d3e

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

Diff for: README.md

+21-19
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
1-
# QM is a containerized environment for running Functional Safety qm (Quality Management) software
2-
3-
1. [QM is a containerized environment for running Functional Safety qm (Quality Management) software](#qm-is-a-containerized-environment-for-running-functional-safety-qm-quality-management-software)
4-
2. [QM Sub Packages](#qm-sub-packages)
5-
- [Key Features of QM Sub-Packages](#key-features-of-qm-sub-packages)
6-
- [Building QM sub-packages](#building-qm-sub-packages)
7-
- [Installing QM sub-packages](Installing-qm-sub-packages)
8-
- [Removing QM sub-packages](Removing-qm-sub-packages)
9-
- [Creating your own drop-in QM sub-package](Creating-your-own-drop-in-QM-sub-package)
10-
- [QM sub-package kvm](QM-sub-package-kvm)
11-
- [QM sub-package Sound](QM-sub-package-Sound)
12-
- [QM sub-package Video](QM-sub-package-Video)
13-
3. [SELinux Policy](#selinux-policy)
14-
4. [BlueChi](#bluechi)
15-
5. [RPM building dependencies](#rpm-building-dependencies)
16-
6. [How the OOM Score Adjustment (`om_score_adj`) is used in QM](#how-the-oom-score-adjustment-om_score_adj-is-used-in-qm)
17-
- [Why use `om_score_adj` in QM?](#why-use-om_score_adj-in-qm)
1+
# Topics
2+
3+
1. [QM is a containerized environment for running Functional Safety QM (Quality Management) software](#qm-is-a-containerized-environment-for-running-functional-safety-qm-quality-management-software)
4+
2. [SELinux Policy](#selinux-policy)
5+
3. [BlueChi](#bluechi)
6+
4. [RPM Building Dependencies](#rpm-building-dependencies)
7+
5. [How the OOM Score Adjustment is Used in QM](#how-the-oom-score-adjustment-is-used-in-qm)
8+
- [Why Use oom score adj in QM?](#why-use-oomscoreadj-in-qm)
189
- [OOM Score Adjustment in QM](#oom-score-adjustment-in-qm)
1910
- [Nested Containers](#nested-containers)
2011
- [QM Process](#qm-process)
2112
- [ASIL Applications](#asil-applications)
2213
- [Highlights](#highlights)
2314
- [ASCII Diagram](#ascii-diagram)
15+
6. [QM Sub-Packages](#qm-sub-packages)
16+
- [Key Features of QM Sub-Packages](#key-features-of-qm-sub-packages)
17+
- [Building QM Sub-Packages](#building-qm-sub-packages)
18+
- [Installing QM Sub-Packages](#installing-qm-sub-packages)
19+
- [Removing QM Sub-Packages](#removing-qm-sub-packages)
20+
- [Creating Your Own Drop-In QM Sub-Package](#creating-your-own-drop-in-qm-sub-package)
21+
- [QM Sub-Package KVM](#qm-sub-package-kvm)
22+
- [QM Sub-Package Sound](#qm-sub-package-sound)
23+
- [QM Sub-Package Video](#qm-sub-package-video)
2424
7. [Examples](#examples)
2525
8. [Development](#development)
2626
9. [RPM Mirrors](#rpm-mirrors)
2727

28+
## QM is a containerized environment for running Functional Safety QM (Quality Management) software
29+
2830
The main purpose of this package is allow users to setup an environment which
2931
prevents applications and container tools from interfering with other processes
3032
on the system. For example ASIL (Automotive Safety Integrity Level) environments.
@@ -458,11 +460,11 @@ Last login: Tue Oct 8 06:01:18 on ttyS0
458460
In order to build qm package on CentOS Stream 9 you'll need Code Ready Builder
459461
repository enabled in order to provide `golang-github-cpuguy83-md2man` package.
460462
461-
## How the OOM Score Adjustment (`om_score_adj`) is used in QM
463+
## How the OOM Score Adjustment is used in QM
462464
463465
The om_score_adj refers to the "Out of Memory score adjustment" in Linux operating systems. This parameter is used by the Out of Memory (OOM) killer to decide which processes to terminate when the system is critically low on memory.
464466
465-
### Why use `om_score_adj` in QM?
467+
### Why use oomscoreadj in QM?
466468
467469
By fine-tuning which processes are more likely to be terminated during low memory situations, critical processes can be protected, thereby enhancing the overall stability of the system. For instance only, ASIL (Automotive Safety Integrity Level) applications, which are critical for ensuring functional safety in automotive systems, will be preserved in case of low resources.
468470

0 commit comments

Comments
 (0)