Skip to content

docs: style fix#2652

Open
viniciusferrao wants to merge 2 commits into
openhpc:4.xfrom
VersatusHPC:docs-style-fix
Open

docs: style fix#2652
viniciusferrao wants to merge 2 commits into
openhpc:4.xfrom
VersatusHPC:docs-style-fix

Conversation

@viniciusferrao

@viniciusferrao viniciusferrao commented Jul 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

This PR normalizes systemctl calls in the install guides to always spell out .service, and adds line spacing to some code snippets.

The guides were inconsistent: most call sites used the bare unit name while a handful spelled out .service, sometimes both ways within the same file (nfs.md.j2, time.md.j2). Per the discussion below, this now normalizes towards .service rather than away from it, which also matches the other unit types the recipes already reference (.socket, .target).

Non-service units keep their own suffix. tests/ci/integration-test.sh matches systemctl restart rsyslog with sed to append || true, so that pattern is updated to keep matching.

Spacing change keeps the pattern of:

# comment
code
<empty line>
# comment
code

@viniciusferrao
docs/install: fix comment spacing in code blocks
52cb824 
A few code blocks run a comment line directly against the previous
command, while every other comment in the same block is preceded by a
blank line. Add the missing blank lines for consistent rendering:

  - network/infiniband/head-node.md.j2 (Start up NetworkManager)
  - scheduler/slurm/install.md.j2 (Setup default cgroups file)
  - customize/memlimits.md.j2 (Update memlock settings on compute)
  - customize/nhc.md.j2 (execute every five minutes)

Cosmetic only.

Signed-off-by: Vinícius Ferrão <ferrao@versatushpc.com.br>
Sponsored-by: VersatusHPC
@github-actions

github-actions Bot commented Jul 11, 2026 •
edited
Loading

Copy link
Copy Markdown

🚀 CCache Statistics

Configuration 🐧 RHEL 🦊 openEuler
🖥️ x86_64 / gnu15 🟢 56.67% 🟢 56.67%
🖥️ x86_64 / intel 🟢 55.56% -
💪 aarch64 / gnu15 🟢 56.67% 🟢 56.67%
📊 Detailed Statistics

openEuler (aarch64)

Cacheable calls:     30 /  62 (48.39%)
  Hits:              17 /  30 (56.67%)
    Direct:          17 /  17 (100.0%)
    Preprocessed:     0 /  17 ( 0.00%)
  Misses:            13 /  30 (43.33%)
Uncacheable calls:   32 /  62 (51.61%)
Local storage:
  Cache size (GiB): 0.0 / 5.0 ( 0.00%)
  Hits:              17 /  30 (56.67%)
  Misses:            13 /  30 (43.33%)

openEuler (x86_64)

Cacheable calls:     30 /  62 (48.39%)
  Hits:              17 /  30 (56.67%)
    Direct:          17 /  17 (100.0%)
    Preprocessed:     0 /  17 ( 0.00%)
  Misses:            13 /  30 (43.33%)
Uncacheable calls:   32 /  62 (51.61%)
Local storage:
  Cache size (GiB): 0.0 / 5.0 ( 0.00%)
  Hits:              17 /  30 (56.67%)
  Misses:            13 /  30 (43.33%)

RHEL (aarch64/gnu15)

Cacheable calls:     30 /  62 (48.39%)
  Hits:              17 /  30 (56.67%)
    Direct:          17 /  17 (100.0%)
    Preprocessed:     0 /  17 ( 0.00%)
  Misses:            13 /  30 (43.33%)
Uncacheable calls:   32 /  62 (51.61%)
Local storage:
  Cache size (GiB): 0.0 / 5.0 ( 0.00%)
  Hits:              17 /  30 (56.67%)
  Misses:            13 /  30 (43.33%)

RHEL (x86_64/gnu15)

Cacheable calls:     30 /  62 (48.39%)
  Hits:              17 /  30 (56.67%)
    Direct:          17 /  17 (100.0%)
    Preprocessed:     0 /  17 ( 0.00%)
  Misses:            13 /  30 (43.33%)
Uncacheable calls:   32 /  62 (51.61%)
Local storage:
  Cache size (GiB): 0.0 / 5.0 ( 0.00%)
  Hits:              17 /  30 (56.67%)
  Misses:            13 /  30 (43.33%)

RHEL (x86_64/intel)

Cacheable calls:     36 / 158 (22.78%)
  Hits:              20 /  36 (55.56%)
    Direct:          20 /  20 (100.0%)
    Preprocessed:     0 /  20 ( 0.00%)
  Misses:            16 /  36 (44.44%)
Uncacheable calls:  122 / 158 (77.22%)
Local storage:
  Cache size (GiB): 0.0 / 5.0 ( 0.00%)
  Hits:              20 /  36 (55.56%)
  Misses:            16 /  36 (44.44%)

🤖 Generated from workflow run 29837754837

@github-actions

github-actions Bot commented Jul 11, 2026 •
edited
Loading

Copy link
Copy Markdown

Test Results

 29 files  ±0  29 suites  ±0   49s ⏱️ -4s
 59 tests ±0  52 ✅  - 1  6 💤 ±0  1 ❌ +1 
105 runs  ±0  96 ✅  - 1  8 💤 ±0  1 ❌ +1 

For more details on these failures, see this check.

Results for commit ebe0190. ± Comparison against base commit 90b91da.

♻️ This comment has been updated with latest results.

This was referenced Jul 11, 2026
Closed
Closed
@middelkoopt
middelkoopt self-requested a review July 20, 2026 16:15
@middelkoopt

middelkoopt commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

I've actually gotten in the habit of typing out these in full when doing this on the CLI (auto-completion). However, are you just normalizing them all to not have .service? (if so, regardless of the style, normalizing them is the way to go. @adrianreber any thoughts on going with .service over removing?

@viniciusferrao

viniciusferrao commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

To be honest it doesn't matter if it have .service or not. I usually type without it. But the idea here is consistency, the vast majority have systemctl without the .service part, so it was to keep everything similar.

@adrianreber

adrianreber commented Jul 21, 2026

Copy link
Copy Markdown
Member

I've actually gotten in the habit of typing out these in full when doing this on the CLI (auto-completion). However, are you just normalizing them all to not have .service? (if so, regardless of the style, normalizing them is the way to go. @adrianreber any thoughts on going with .service over removing?

Consistency is nice. Not sure what is better. Having .service sounds good as there are also things like .timer, .socket, .mount. Which means for things like those you have to use it. So having .service everywhere sound also right.

@viniciusferrao
docs/install: spell out .service in systemctl calls
ebe0190 
The guides were inconsistent: most systemctl call sites used the bare unit
name while a handful spelled out .service, sometimes both ways within the
same file (nfs.md.j2, time.md.j2). Normalize on the explicit .service
suffix, which is also what is needed for the other unit types the recipes
already reference (.socket, .target).

Units that are not services keep their own suffix, and `journalctl -u` in
the OpenCHAMI quadlet tip is aligned with the systemctl calls next to it.

tests/ci/integration-test.sh matches `systemctl restart rsyslog` with sed to
append `|| true`; the pattern is updated so it keeps matching.

Cosmetic only -- verified with `make script` + `make check` (shellcheck).

Signed-off-by: Vinícius Ferrão <ferrao@versatushpc.com.br>
Sponsored-by: VersatusHPC
@viniciusferrao

viniciusferrao commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Fixes implemented, .service is added not only on systemctl but also where it applies when running journalctl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@middelkoopt middelkoopt Awaiting requested review from middelkoopt

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@viniciusferrao @middelkoopt @adrianreber