summaryrefslogtreecommitdiff
path: root/util/kconfig/README.md
diff options
context:
space:
mode:
authorRichard Marko <srk@48.io>2023-10-18 19:57:15 +0200
committerFelix Held <felix-coreboot@felixheld.de>2023-10-31 17:06:04 +0000
commit374381189458505bfac5d7c40bed92b0420670d8 (patch)
treeac481fbce9f28d70d669de28168774525053d2ed /util/kconfig/README.md
parent6bb4603ed6fb93982fb0c0e53b3338ab5884f85a (diff)
util/kconfig: Fix README.md formatting
Change-Id: I0c47a603cc6e6174cd4895ff9f44b5bc242c653e Signed-off-by: Richard Marko <srk@48.io> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78441 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'util/kconfig/README.md')
-rw-r--r--util/kconfig/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/util/kconfig/README.md b/util/kconfig/README.md
index 4d508a5e19..a02d903aeb 100644
--- a/util/kconfig/README.md
+++ b/util/kconfig/README.md
@@ -13,7 +13,9 @@ The first step is to unapply the patches. This can either be done with quilt
in an already-configured tree (`quilt pop -a` should cleanly unapply them all)
or manually if quilt doesn't have its tracking metadata around yet:
- $ for i in `ls patches/*.patch | tac`; do patch -p1 -R -i "$i"; done
+```sh
+for i in $( ls patches/*.patch | tac ); do patch -p1 -R -i "$i"; done
+```
The result should be a subtree that, apart from a few coreboot specific
files on our side (e.g. documentation, integration in our build system)
@@ -23,9 +25,11 @@ uprev we did. Check the uprev version by looking through
`git log util/kconfig` output in our tree.
Assuming that you want to uprev from Linux 5.13 to 5.14, with a Linux git tree
-available in ~/linux,
+available in `~/linux`
- $ cd util/kconfig && (cd ~/linux/ && git diff v5.13..v5.14 scripts/kconfig) | patch -p2`
+```sh
+cd util/kconfig && (cd ~/linux/ && git diff v5.13..v5.14 scripts/kconfig) | patch -p2`
+```
applies the changes to your local tree.
@@ -39,6 +43,7 @@ write a meaningful commit message that documents what Linux kconfig version
the tree has been upreved to.
## Adding a new patch
+
The format of the patches to kconfig is a mix of the headers produced by `git
format-patch` and the patch format of quilt. However neither git nor quilt
seems to have any functionality to directly produce a file in such a format