summaryrefslogtreecommitdiff
path: root/util
diff options
context:
space:
mode:
authorMartin Roth <gaumless@gmail.com>2022-05-22 20:07:55 -0600
committerMartin L Roth <gaumless@tutanota.com>2022-05-30 13:05:21 +0000
commit74129e51411c26ffcb61607f676059799198bb34 (patch)
tree30bf47dce6a5936c1c7e4b2c7d073bc597b2a6e2 /util
parentd5c31acee4879ef9bc9d64b7ef9d85d078741c99 (diff)
util: Update description files
- Spelling fix - Add languages - Update formatting - Move notes that shouldn't be in the description file to a README Change-Id: I4af37327d5834f8546a3f967585658fb5686f17a Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/64581 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net> Reviewed-by: Maxim Polyakov <max.senia.poliak@gmail.com> Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
Diffstat (limited to 'util')
-rw-r--r--util/amdtools/description.md18
-rw-r--r--util/crossgcc/description.md2
-rw-r--r--util/docker/description.md2
-rw-r--r--util/find_usbdebug/description.md2
-rw-r--r--util/intelp2m/description.md2
-rw-r--r--util/ipqheader/description.md2
-rw-r--r--util/liveiso/README.md9
-rw-r--r--util/liveiso/description.md11
-rw-r--r--util/qemu/description.md2
-rw-r--r--util/scripts/description.md2
10 files changed, 28 insertions, 24 deletions
diff --git a/util/amdtools/description.md b/util/amdtools/description.md
index fc9f1c5d46..3b1287d5e2 100644
--- a/util/amdtools/description.md
+++ b/util/amdtools/description.md
@@ -1,11 +1,13 @@
-Various tools for AMD processors
-* update_efs_spi_speed - Change SPI speed in binary. `Bash`
-* A set of tools to compare extended K8 memory settings. `Perl`
- * k8-compare-pci-space.pl - Shows differences between values
+__amdtools__ Various tools for AMD processors
+
+* _update_efs_spi_speed_ - Change SPI speed in binary. `Bash`
+
+* Tools to compare extended K8 memory settings.
+ * _k8-compare-pci-space.pl_ - Shows differences between values
in PCI space and the default value. `Perl`
- * k8-interpret-extended-memory-settings.pl - Shows differences
+ * _k8-interpret-extended-memory-settings.pl_ - Shows differences
between memory controller values and the default value. `Perl`
- * k8-read-mem-settings.sh - Makes data files understood by the
+ * _k8-read-mem-settings.sh_ - Makes data files understood by the
k8-interpret-extended-memory-settings script. `Bash`
- * parse-bkdg.pl - Make bkdg.data file used by above scripts. `Perl`
- * example_input - Sample input for the above scripts. `Text`
+ * _parse-bkdg.pl_ - Make bkdg.data file used by above scripts. `Perl`
+ * _example_input_ - Sample input for the above scripts. `Text`
diff --git a/util/crossgcc/description.md b/util/crossgcc/description.md
index fa37c2b6ab..a99944fa29 100644
--- a/util/crossgcc/description.md
+++ b/util/crossgcc/description.md
@@ -1 +1 @@
-A cross toolchain builder for -elf toolchains (ie. no libc support)
+A cross toolchain builder for -elf toolchains (ie. no libc support) `Bash`
diff --git a/util/docker/description.md b/util/docker/description.md
index a45d1da014..522fa02891 100644
--- a/util/docker/description.md
+++ b/util/docker/description.md
@@ -1,2 +1,2 @@
Dockerfiles for _coreboot-sdk_, _coreboot-jenkins-node_,
-_coreboot.org-status_ and _docs.coreboot.org_
+_coreboot.org-status_ and _docs.coreboot.org_ `Make`
diff --git a/util/find_usbdebug/description.md b/util/find_usbdebug/description.md
index 1497603314..ea266b29e2 100644
--- a/util/find_usbdebug/description.md
+++ b/util/find_usbdebug/description.md
@@ -1 +1 @@
-Help find USB debug ports
+Help find USB debug ports `Bash`
diff --git a/util/intelp2m/description.md b/util/intelp2m/description.md
index fd1a15b599..5d718b02d9 100644
--- a/util/intelp2m/description.md
+++ b/util/intelp2m/description.md
@@ -1,2 +1,2 @@
convert the configuration DW0/1 registers value from an inteltool dump
-to coreboot macros. 'go'
+to coreboot macros. `go`
diff --git a/util/ipqheader/description.md b/util/ipqheader/description.md
index f747b562f6..cfe53e8eee 100644
--- a/util/ipqheader/description.md
+++ b/util/ipqheader/description.md
@@ -1,5 +1,5 @@
__ipqheader__
- * _createxbl.py_ - Concatentates XBL segments into one ELF image
+ * _createxbl.py_ - Concatenates XBL segments into one ELF image
`Python`
* _ipqheader.py_ - Returns a packed MBN header image with the
specified base and size `Python`
diff --git a/util/liveiso/README.md b/util/liveiso/README.md
new file mode 100644
index 0000000000..48420e6f6c
--- /dev/null
+++ b/util/liveiso/README.md
@@ -0,0 +1,9 @@
+# Live ISO
+
+## What is this?
+
+NixOS configuration files for testing purposes and for working on firmware.
+
+## TODO
+- Generate customized bootloader configs; FILO is WIP
+- Switch to `programs.neovim` when the module is fixed.
diff --git a/util/liveiso/description.md b/util/liveiso/description.md
index 48420e6f6c..fb4b89d280 100644
--- a/util/liveiso/description.md
+++ b/util/liveiso/description.md
@@ -1,9 +1,2 @@
-# Live ISO
-
-## What is this?
-
-NixOS configuration files for testing purposes and for working on firmware.
-
-## TODO
-- Generate customized bootloader configs; FILO is WIP
-- Switch to `programs.neovim` when the module is fixed.
+A script and NixOS configuration files to create an ISO image for
+testing purposes and for working on firmware. `Bash`
diff --git a/util/qemu/description.md b/util/qemu/description.md
index 6e3a16c398..77702697fb 100644
--- a/util/qemu/description.md
+++ b/util/qemu/description.md
@@ -1,3 +1,3 @@
__qemu__
-- Makefile & comprehensive default config for QEMU Q35 emulation
+- Makefile & comprehensive default config for QEMU Q35 emulation `Make`
diff --git a/util/scripts/description.md b/util/scripts/description.md
index a08771d48d..0d6cedbd76 100644
--- a/util/scripts/description.md
+++ b/util/scripts/description.md
@@ -4,7 +4,7 @@ __scripts__
* _cross-repo-cherrypick_ - Pull in patches from another tree from a
gerrit repository. `Shell`
* _decode_spd.sh_ - Decodes Serial Presence Detect (SPD) files into
- various human readable formats.
+ various human readable formats. `Bash`
* _dts-to-fmd.sh_ -Converts a depthcharge fmap.dts into an fmaptool
compatible .fmd format `Bash`
* _find-unused-kconfig-symbols.sh_ - Points out Kconfig variables