All of lore.kernel.org
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: yocto-patches@lists.yoctoproject.org
Cc: twoerner@gmail.com
Subject: [wic][PATCH] README.md: literal cleanups
Date: Thu, 11 Jun 2026 08:42:08 -0400	[thread overview]
Message-ID: <20260611124208.3292869-1-twoerner@gmail.com> (raw)

Using ```bash works in almost all markdown renderers, but unfortunately
does not work on git.yoctoproject.org. Instead it inserts "bash" at the
start of any such literal code block that uses it.

Technically a code block in markdown requires 4 spaces, not 3. Therefore
the "git send-email ..." command would not be offset correctly in most
markdown renderers. Either add another space, or delimit with ``` to
match the other code blocks; I chose the latter.

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 README.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 32590195fae1..75229421763c 100644
--- a/README.md
+++ b/README.md
@@ -10,33 +10,33 @@ environment file or folder (generated via `bitbake -c rootfs_wicenv
 ### Using wicenv (one environment file)
 1. Ensure you have a BitBake-generated `<image>.env` file (from `rootfs_wicenv`).
 2. Install locally for development:
-   ```bash
+   ```
    hatch shell
    ```
 3. Run the CLI:
-   ```bash
+   ```
    hatch run wic --vars /path/to/<image>.env --help
    ```
 
 ### Using wicenv (environment folder)
 1. Ensure you have a folder with BitBake-generated `<image>.env` files (from `rootfs_wicenv`).
 2. Install locally for development:
-   ```bash
+   ```
    hatch shell
    ```
 3. Run the CLI:
-   ```bash
+   ```
    hatch run wic --vars /path/to/envfiledir --help
    ```
 
 ### With bitbake
 1. Ensure you have bitbake available in your PATH.
 2. Install locally for development:
-   ```bash
+   ```
    hatch shell
    ```
 3. Run the CLI:
-   ```bash
+   ```
    hatch run wic --help
    ```
 
@@ -63,7 +63,9 @@ recipients.
 
 When generating the patches manually, this will generate what's expected:
 
-   git send-email -M -1 --to yocto-patches@lists.yoctoproject.org --cc twoerner@gmail.com --subject-prefix='wic][PATCH'
+```
+git send-email -M -1 --to yocto-patches@lists.yoctoproject.org --cc twoerner@gmail.com --subject-prefix='wic][PATCH'
+```
 
 Nothing, except running `b4 send` to actually send the patches, needs to be done
 when using [b4](https://b4.docs.kernel.org/).
-- 
2.51.0



             reply	other threads:[~2026-06-11 12:42 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-11 12:42 Trevor Woerner [this message]
2026-06-11 13:02 ` [yocto-patches] [wic][PATCH] README.md: literal cleanups Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260611124208.3292869-1-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=yocto-patches@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.