From ff2c2d0850c4f5a3aa9bea074e110c9b9725d29e Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 13 Dec 2019 11:56:08 +0100 Subject: [PATCH] docs: make sure there's only one # markdown header in each file MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit @bertob wants us to be strict here, and only have one "#" header per markdown file, and use "##" (or "###", …) for all others. Interestingly, we mostly got this right already, but this fixes a few cases where this wasn't correct. --- docs/AUTOMATIC_BOOT_ASSESSMENT.md | 6 +++--- docs/CODING_STYLE.md | 2 +- docs/TRANSLATORS.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/AUTOMATIC_BOOT_ASSESSMENT.md b/docs/AUTOMATIC_BOOT_ASSESSMENT.md index c7f5bb35f88..aff203b5906 100644 --- a/docs/AUTOMATIC_BOOT_ASSESSMENT.md +++ b/docs/AUTOMATIC_BOOT_ASSESSMENT.md @@ -56,7 +56,7 @@ components: script can optionally create boot loader entries that carry an initial boot counter (the initial counter is configurable in `/etc/kernel/tries`). -# Details +## Details The boot counting data `systemd-boot` and `systemd-bless-boot.service` manage is stored in the name of the boot loader entries. If a boot loader entry @@ -149,7 +149,7 @@ scenario the first 4 steps are the same as above: 12. On the following boot (and all subsequent boots after that) the entry is now seen with boot counting turned off, no further renaming takes place. -# How to adapt this scheme to other setups +## How to adapt this scheme to other setups Of the stack described above many components may be replaced or augmented. Here are a couple of recommendations. @@ -180,7 +180,7 @@ are a couple of recommendations. wrap them in a unit and order them after `boot-complete.target`, pulling it in. -# FAQ +## FAQ 1. *Why do you use file renames to store the counter? Why not a regular file?* — Mainly two reasons: it's relatively likely that renames can be implemented diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index 9e480a649ef..c8ca8bfefca 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -543,7 +543,7 @@ layout: default time you need that please immediately undefine `basename()`, and add a comment about it, so that no code ever ends up using the POSIX version! -# Committing to git +## Committing to git - Commit message subject lines should be prefixed with an appropriate component name of some kind. For example "journal: ", "nspawn: " and so on. diff --git a/docs/TRANSLATORS.md b/docs/TRANSLATORS.md index f4553f559d1..a120bcafbc5 100644 --- a/docs/TRANSLATORS.md +++ b/docs/TRANSLATORS.md @@ -69,7 +69,7 @@ Once you're done, create a git commit for the update of the `po/*.po` file you touched. Remember to undo the changes to the other `*.po` files (for instance, using `git checkout -- po/` after you commit the changes you do want to keep.) -# Recompiling Translations +## Recompiling Translations You can recompile the `*.po` files using the following command: -- 2.47.3