coreboot-gerrit April 2021

coreboot-gerrit@coreboot.org

1 participants
6267 discussions

Change in coreboot[master]: util/bincfg: Clean up Makefile
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/50654 ) Change subject: util/bincfg: Clean up Makefile ...................................................................... Patch Set 2: (1 comment) File util/bincfg/Makefile: https://review.coreboot.org/c/coreboot/+/50654/comment/5026074e_be689404 PS1, Line 30: ./bincfg > should these be $(abspath $(TARGET)) or something? Updating in a follow-on patch -- To view, visit https://review.coreboot.org/c/coreboot/+/50654 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: Ic0302f663cbc931325334d0cce93d3b0bf937cc6 Gerrit-Change-Number: 50654 Gerrit-PatchSet: 2 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: Angel Pons <th3fanbus(a)gmail.com> Gerrit-Reviewer: Arthur Heymans <arthur(a)aheymans.xyz> Gerrit-Reviewer: Patrick Georgi <pgeorgi(a)google.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Comment-Date: Mon, 05 Apr 2021 17:20:53 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Patrick Georgi <pgeorgi(a)google.com> Gerrit-MessageType: comment

1 0

Change in coreboot[master]: util: Update existing description.md files
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/48965 ) Change subject: util: Update existing description.md files ...................................................................... util: Update existing description.md files * Add links to the cbfstool & ifdtool documentation * Split intelp2m documentation into description.md & README.md files. The original description.md file was too much to include in the util.md file, and should be linked. Signed-off-by: Martin Roth <martin(a)coreboot.org> Change-Id: I3851ac330140dd69f414a19214901549f47dac63 --- M util/cbfstool/description.md M util/ifdtool/description.md A util/intelp2m/README.md M util/intelp2m/description.md 4 files changed, 181 insertions(+), 178 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/65/48965/1 diff --git a/util/cbfstool/description.md b/util/cbfstool/description.md index 63b50f2..915c44b 100644 --- a/util/cbfstool/description.md +++ b/util/cbfstool/description.md @@ -1,5 +1,5 @@ __cbfstool__ - * _cbfstool_ - For manipulating CBFS file `C` + * [_cbfstool_](cbfstool/index.md) - For manipulating CBFS file `C` * _fmaptool_ - Converts plaintext fmd files into fmap blobs `C` * _rmodtool_ - Creates rmodules `C` * _ifwitool_ - For manipulating IFWI `C` diff --git a/util/ifdtool/description.md b/util/ifdtool/description.md index 813d401..9f91b83 100644 --- a/util/ifdtool/description.md +++ b/util/ifdtool/description.md @@ -1 +1,3 @@ -Extract and dump Intel Firmware Descriptor information `C` +[__ifdtool__](ifdtool/index.md) + +- Extract and dump Intel Firmware Descriptor information `C` diff --git a/util/intelp2m/README.md b/util/intelp2m/README.md new file mode 100644 index 0000000..1aaee40 --- /dev/null +++ b/util/intelp2m/README.md @@ -0,0 +1,176 @@ +Intel Pad to Macro (intelp2m) converter +======================================= + +This utility allows to convert the configuration DW0/1 registers value +from [inteltool](../inteltool/description.md) dump to coreboot macros. + +```bash +(shell)$ make +(shell)$ ./intelp2m -h +(shell)$ ./intelp2m -file /path/to/inteltool.log +``` + +### Platforms + +It is possible to use templates for parsing files of excellent inteltool.log. +To specify such a pattern, use the option -t <template number>. For example, +using template type # 1, you can parse gpio.h from an already added board in +the coreboot project. +```bash +(shell)$ ./intelp2m -h + -t + template type number + 0 - inteltool.log (default) + 1 - gpio.h + 2 - your template +(shell)$ ./intelp2m -t 1 -file coreboot/src/mainboard/yourboard/gpio.h +``` +You can also add a template to 'parser/template.go' for your file type with +the configuration of the pads. + +platform type is set using the -p option (Sunrise by default): +```bash + -p string + set up a platform + snr - Sunrise PCH with Skylake/Kaby Lake CPU + lbg - Lewisburg PCH with Xeon SP CPU + apl - Apollo Lake SoC + cnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC + (default "snr") + +(shell)$ ./intelp2m -p <platform> -file path/to/inteltool.log +``` + +### Packages + +![][pckgs] + +[pckgs]: config/gopackages.png + +### Bit fields in macros + +Use the -fld=cb option to only generate a sequence of bit fields in a new macro: + +```bash +(shell)$ ./intelp2m -fld cb -p apl -file ../apollo-inteltool.log +``` +```c +_PAD_CFG_STRUCT(GPIO_37, PAD_FUNC(NF1) | PAD_TRIG(OFF) | PAD_TRIG(OFF), PAD_PULL(DN_20K)), /* LPSS_UART0_TXD */ +``` + +### Raw DW0, DW1 register value + +To generate the gpio.c with raw PAD_CFG_DW0 and PAD_CFG_DW1 register values you need +to use the -fld=raw option: + +```bash + (shell)$ ./intelp2m -fld raw -file /path/to/inteltool.log +``` +```c +_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), +``` + +```bash + (shell)$ ./intelp2m -iiii -fld raw -file /path/to/inteltool.log +``` +```c +/* GPP_A10 - CLKOUT_LPC1 */ +/* DW0: 0x44000500, DW1: 0x00000000 */ +/* DW0: 0x04000100 - IGNORED */ +/* PAD_CFG_NF(GPP_A10, NONE, DEEP, NF1), */ +_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), +``` + +### Macro Check + +After generating the macro, the utility checks all used +fields of the configuration registers. If some field has been +ignored, the utility generates field macros. To not check +macros, use the -n option: +```bash +(shell)$ ./intelp2m -n -file /path/to/inteltool.log +``` + +In this case, some fields of the configuration registers +DW0 will be ignored. +```c +PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_38, UP_20K, DEEP, NF1, HIZCRx1, DISPUPD), +PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), +``` + +### Information level + +The utility can generate additional information about the bit +fields of the DW0 and DW1 configuration registers. Using the +options -i, -ii, -iii, -iiii you can set the info level from +1 to 4: + +```bash +(shell)$./intelp2m -i -file /path/to/inteltool.log +``` +```c +_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), /* LPSS_UART0_TXD */ +``` + +```bash +(shell)$./intelp2m -ii -file /path/to/inteltool.log +(shell)$./intelp2m -iii -file /path/to/inteltool.log +(shell)$./intelp2m -iiii -file /path/to/inteltool.log +``` +```c +/* GPIO_39 - LPSS_UART0_TXD */ +/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii) +/* DW0 : PAD_TRIG(OFF) - IGNORED */ --> (iii) +/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), */ --> (iiii) +_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), +``` + +If the -n switch was used and macros was generated without checking: +```c +/* GPIO_39 - LPSS_UART0_TXD */ --> (i) +/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii) +/* DW0: PAD_TRIG(OFF) - IGNORED */ --> (iii) +/* _PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), */ --> (iiii) +PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), +``` + +### Ignoring Fields + +Utilities can generate the _PAD_CFG_STRUCT macro and exclude fields +from it that are not in the corresponding PAD_CFG_*() macro: + +```bash +(shell)$ ./intelp2m -iiii -fld cb -ign -file /path/to/inteltool.log +``` +```c +/* GPIO_39 - LPSS_UART0_TXD */ +/* DW0: 0x44000400, DW1: 0x00003100 */ +/* DW0: PAD_TRIG(OFF) - IGNORED */ +/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), */ +_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), +``` + +### FSP-style macro + +The utility allows to generate macros that include fsp/edk2-palforms style bitfields: + +```bash +(shell)$ ./intelp2m -i -fld fsp -p lbg -file ../crb-inteltool.log +``` +```c +{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut, GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone, GpioPadConfigLock }, /* GPIO */ +``` + +```bash +(shell)$ ./intelp2m -iiii -fld fsp -p lbg -file ../crb-inteltool.log +``` +```c +/* GPP_A12 - GPIO */ +/* DW0: 0x80880102, DW1: 0x00000000 */ +/* PAD_CFG_GPI_SCI(GPP_A12, NONE, PLTRST, LEVEL, INVERT), */ +{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut, GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone, GpioPadConfigLock }, +``` + +### Supports Chipsets + + Sunrise PCH, Lewisburg PCH, Apollo Lake SoC, CannonLake-LP SoCs diff --git a/util/intelp2m/description.md b/util/intelp2m/description.md index 1aaee40..1058e72 100644 --- a/util/intelp2m/description.md +++ b/util/intelp2m/description.md @@ -1,176 +1 @@ -Intel Pad to Macro (intelp2m) converter -======================================= - -This utility allows to convert the configuration DW0/1 registers value -from [inteltool](../inteltool/description.md) dump to coreboot macros. - -```bash -(shell)$ make -(shell)$ ./intelp2m -h -(shell)$ ./intelp2m -file /path/to/inteltool.log -``` - -### Platforms - -It is possible to use templates for parsing files of excellent inteltool.log. -To specify such a pattern, use the option -t <template number>. For example, -using template type # 1, you can parse gpio.h from an already added board in -the coreboot project. -```bash -(shell)$ ./intelp2m -h - -t - template type number - 0 - inteltool.log (default) - 1 - gpio.h - 2 - your template -(shell)$ ./intelp2m -t 1 -file coreboot/src/mainboard/yourboard/gpio.h -``` -You can also add a template to 'parser/template.go' for your file type with -the configuration of the pads. - -platform type is set using the -p option (Sunrise by default): -```bash - -p string - set up a platform - snr - Sunrise PCH with Skylake/Kaby Lake CPU - lbg - Lewisburg PCH with Xeon SP CPU - apl - Apollo Lake SoC - cnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC - (default "snr") - -(shell)$ ./intelp2m -p <platform> -file path/to/inteltool.log -``` - -### Packages - -![][pckgs] - -[pckgs]: config/gopackages.png - -### Bit fields in macros - -Use the -fld=cb option to only generate a sequence of bit fields in a new macro: - -```bash -(shell)$ ./intelp2m -fld cb -p apl -file ../apollo-inteltool.log -``` -```c -_PAD_CFG_STRUCT(GPIO_37, PAD_FUNC(NF1) | PAD_TRIG(OFF) | PAD_TRIG(OFF), PAD_PULL(DN_20K)), /* LPSS_UART0_TXD */ -``` - -### Raw DW0, DW1 register value - -To generate the gpio.c with raw PAD_CFG_DW0 and PAD_CFG_DW1 register values you need -to use the -fld=raw option: - -```bash - (shell)$ ./intelp2m -fld raw -file /path/to/inteltool.log -``` -```c -_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), -``` - -```bash - (shell)$ ./intelp2m -iiii -fld raw -file /path/to/inteltool.log -``` -```c -/* GPP_A10 - CLKOUT_LPC1 */ -/* DW0: 0x44000500, DW1: 0x00000000 */ -/* DW0: 0x04000100 - IGNORED */ -/* PAD_CFG_NF(GPP_A10, NONE, DEEP, NF1), */ -_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), -``` - -### Macro Check - -After generating the macro, the utility checks all used -fields of the configuration registers. If some field has been -ignored, the utility generates field macros. To not check -macros, use the -n option: -```bash -(shell)$ ./intelp2m -n -file /path/to/inteltool.log -``` - -In this case, some fields of the configuration registers -DW0 will be ignored. -```c -PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_38, UP_20K, DEEP, NF1, HIZCRx1, DISPUPD), -PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), -``` - -### Information level - -The utility can generate additional information about the bit -fields of the DW0 and DW1 configuration registers. Using the -options -i, -ii, -iii, -iiii you can set the info level from -1 to 4: - -```bash -(shell)$./intelp2m -i -file /path/to/inteltool.log -``` -```c -_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), /* LPSS_UART0_TXD */ -``` - -```bash -(shell)$./intelp2m -ii -file /path/to/inteltool.log -(shell)$./intelp2m -iii -file /path/to/inteltool.log -(shell)$./intelp2m -iiii -file /path/to/inteltool.log -``` -```c -/* GPIO_39 - LPSS_UART0_TXD */ -/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii) -/* DW0 : PAD_TRIG(OFF) - IGNORED */ --> (iii) -/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), */ --> (iiii) -_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), -``` - -If the -n switch was used and macros was generated without checking: -```c -/* GPIO_39 - LPSS_UART0_TXD */ --> (i) -/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii) -/* DW0: PAD_TRIG(OFF) - IGNORED */ --> (iii) -/* _PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), */ --> (iiii) -PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), -``` - -### Ignoring Fields - -Utilities can generate the _PAD_CFG_STRUCT macro and exclude fields -from it that are not in the corresponding PAD_CFG_*() macro: - -```bash -(shell)$ ./intelp2m -iiii -fld cb -ign -file /path/to/inteltool.log -``` -```c -/* GPIO_39 - LPSS_UART0_TXD */ -/* DW0: 0x44000400, DW1: 0x00003100 */ -/* DW0: PAD_TRIG(OFF) - IGNORED */ -/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD), */ -_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), -``` - -### FSP-style macro - -The utility allows to generate macros that include fsp/edk2-palforms style bitfields: - -```bash -(shell)$ ./intelp2m -i -fld fsp -p lbg -file ../crb-inteltool.log -``` -```c -{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut, GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone, GpioPadConfigLock }, /* GPIO */ -``` - -```bash -(shell)$ ./intelp2m -iiii -fld fsp -p lbg -file ../crb-inteltool.log -``` -```c -/* GPP_A12 - GPIO */ -/* DW0: 0x80880102, DW1: 0x00000000 */ -/* PAD_CFG_GPI_SCI(GPP_A12, NONE, PLTRST, LEVEL, INVERT), */ -{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut, GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone, GpioPadConfigLock }, -``` - -### Supports Chipsets - - Sunrise PCH, Lewisburg PCH, Apollo Lake SoC, CannonLake-LP SoCs +Intel Pad to Macro (intelp2m) converter 'Go' -- To view, visit https://review.coreboot.org/c/coreboot/+/48965 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I3851ac330140dd69f414a19214901549f47dac63 Gerrit-Change-Number: 48965 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: Stefan Reinauer <stefan.reinauer(a)coreboot.org> Gerrit-MessageType: newchange

1 1

Change in coreboot[master]: util/util_readme - Handle links in util description.md files
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/48964 ) Change subject: util/util_readme - Handle links in util description.md files ...................................................................... util/util_readme - Handle links in util description.md files The Documentation/util.md file had been edited to add some links to additional supporting documentation. This change allows those links to be added directly to the description.md file. Some code has been added so that the links are stripped from the util/README.md file. Signed-off-by: Martin Roth <martin(a)coreboot.org> Change-Id: Ie06f9ceab10a3993f592256e53cdf70570ade778 --- M util/util_readme/util_readme.sh 1 file changed, 11 insertions(+), 2 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/64/48964/1 diff --git a/util/util_readme/util_readme.sh b/util/util_readme/util_readme.sh index 168bde0..63f6cfb 100755 --- a/util/util_readme/util_readme.sh +++ b/util/util_readme/util_readme.sh @@ -32,13 +32,22 @@ UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev) DESC=$(cat "$DESC_FILE") - if [[ $DESC == "__"${UTIL_NAME}* || $DESC == "__["${UTIL_NAME}* ]]; then + if [[ $DESC =~ \[__${UTIL_NAME} ]]; then + PLAINDESC="* ${DESC//\[__${UTIL_NAME}__\]$*$/__${UTIL_NAME}__}" DESC="* $DESC" + elif [[ $DESC == "__"${UTIL_NAME}* || $DESC == "__["${UTIL_NAME}* ]]; then + DESC="* $DESC" + PLAINDESC="$DESC" else DESC="* __${UTIL_NAME}__ - $DESC" + PLAINDESC="$DESC" fi - fmtstring "$DESC" >> "$UTIL_DIR/README.md" + if [[ $DESC =~ \[_${UTIL_NAME} ]]; then + PLAINDESC="${PLAINDESC//\[_${UTIL_NAME}_\]$*$/_${UTIL_NAME}_}" + fi + + fmtstring "$PLAINDESC" >> "$UTIL_DIR/README.md" fmtstring "$DESC" >> "$DOCMENTATION_DIR/util.md" done -- To view, visit https://review.coreboot.org/c/coreboot/+/48964 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: Ie06f9ceab10a3993f592256e53cdf70570ade778 Gerrit-Change-Number: 48964 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-MessageType: newchange

2 3

Change in coreboot[master]: util/util_readme: Update summary and tail to match current docs
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/48963 ) Change subject: util/util_readme: Update summary and tail to match current docs ...................................................................... util/util_readme: Update summary and tail to match current docs The top and bottom of the generated file have been changed in the documentation directory, so update what's generated by creating markdown files in the util_readme directory. This change also adds a note at the bottom of the documentation file that it's generated and the markdown in the util_readme directory should be edited instead. Signed-off-by: Martin Roth <martin(a)coreboot.org> Change-Id: I020a94e66ada320e49bd78125d59a09b237015f5 --- A util/util_readme/bottom_text.md A util/util_readme/header_text.md M util/util_readme/util_readme.sh 3 files changed, 24 insertions(+), 3 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/63/48963/1 diff --git a/util/util_readme/bottom_text.md b/util/util_readme/bottom_text.md new file mode 100644 index 0000000..4a7dc68 --- /dev/null +++ b/util/util_readme/bottom_text.md @@ -0,0 +1,16 @@ + + + ## In depth documentation + +* [ifdtool](ifdtool/index.md) + +## Generated documentation + +**Please do not edit the markdown file in the documentation directory +*directly.** + +This file was generated by running util_readme.sh. Please make sure it +is rerun when new tools are added or when documentation is updated. + +To update, edit the markdown files in the util directory, then +re-generate this file by running `util/util_readme/util_readme.sh` diff --git a/util/util_readme/header_text.md b/util/util_readme/header_text.md new file mode 100644 index 0000000..47769c7 --- /dev/null +++ b/util/util_readme/header_text.md @@ -0,0 +1,5 @@ +# Utilities + +## List of utils + +_Scripts and programs found in the coreboot `./util` directory_ diff --git a/util/util_readme/util_readme.sh b/util/util_readme/util_readme.sh index 64b4232..168bde0 100755 --- a/util/util_readme/util_readme.sh +++ b/util/util_readme/util_readme.sh @@ -10,7 +10,6 @@ UTIL_DIR=$(dirname "$UTIL_README_DIR") COREBOOT_ROOT_DIR=$(dirname "$UTIL_DIR") DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation" -SUMMARY="_Scripts and programs found in the \`./util\` directory_" # format description to under 72 characters per line and only # breaking on whitespace @@ -27,8 +26,7 @@ DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort) echo -n "" > "$UTIL_DIR/README.md" -echo "# Utilities" > "$DOCMENTATION_DIR/util.md" -echo "$SUMMARY" >> "$DOCMENTATION_DIR/util.md" +cat "${UTIL_README_DIR}/header_text.md" > "$DOCMENTATION_DIR/util.md" for DESC_FILE in $DESCRIPTION_FILES; do UTIL_NAME=$(echo "$DESC_FILE" | rev | cut -d '/' -f2 | rev) @@ -43,3 +41,5 @@ fmtstring "$DESC" >> "$UTIL_DIR/README.md" fmtstring "$DESC" >> "$DOCMENTATION_DIR/util.md" done + +cat "${UTIL_README_DIR}/bottom_text.md" >> "$DOCMENTATION_DIR/util.md" -- To view, visit https://review.coreboot.org/c/coreboot/+/48963 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I020a94e66ada320e49bd78125d59a09b237015f5 Gerrit-Change-Number: 48963 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-MessageType: newchange

2 4

Change in coreboot[master]: util/util_readme: Make string formatting its own function
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/48962 ) Change subject: util/util_readme: Make string formatting its own function ...................................................................... util/util_readme: Make string formatting its own function In preparation for treating the output to the UTIL_DIR and the DOCUMENTATION_DIR differently, move the description formatting to its own function. Signed-off-by: Martin Roth <martin(a)coreboot.org> Change-Id: If405083460bbc095a84c92845a3fddd951feec5c --- M util/util_readme/util_readme.sh 1 file changed, 14 insertions(+), 11 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/62/48962/1 diff --git a/util/util_readme/util_readme.sh b/util/util_readme/util_readme.sh index af688c4..64b4232 100755 --- a/util/util_readme/util_readme.sh +++ b/util/util_readme/util_readme.sh @@ -12,6 +12,18 @@ DOCMENTATION_DIR="$COREBOOT_ROOT_DIR/Documentation" SUMMARY="_Scripts and programs found in the \`./util\` directory_" +# format description to under 72 characters per line and only +# breaking on whitespace +fmtstring() { + echo "$1" \ + | tr '\r\n' ' ' \ + | sed 's/ [*]\+/\n\t\*/g' \ + | sed 's/ \+/ /g' \ + | fold -s -w72 \ + | sed 's/\s*$//' + echo +} + DESCRIPTION_FILES=$(find "$UTIL_DIR" -name "description.md" | sort) echo -n "" > "$UTIL_DIR/README.md" @@ -28,15 +40,6 @@ DESC="* __${UTIL_NAME}__ - $DESC" fi - # format description to under 72 characters per line and only - # breaking on whitespace - DESC=$(echo "$DESC" \ - | tr '\r\n' ' ' \ - | sed 's/ [*]\+/\n\t\*/g' \ - | sed 's/ \+/ /g' \ - | fold -s -w72 \ - | sed 's/\s*$//') - - echo "$DESC" >> "$UTIL_DIR/README.md" - echo "$DESC" >> "$DOCMENTATION_DIR/util.md" + fmtstring "$DESC" >> "$UTIL_DIR/README.md" + fmtstring "$DESC" >> "$DOCMENTATION_DIR/util.md" done -- To view, visit https://review.coreboot.org/c/coreboot/+/48962 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: If405083460bbc095a84c92845a3fddd951feec5c Gerrit-Change-Number: 48962 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-MessageType: newchange

2 2

Change in coreboot[master]: Update vboot submodule to upstream master
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has abandoned this change. ( https://review.coreboot.org/c/coreboot/+/51471 ) Change subject: Update vboot submodule to upstream master ...................................................................... Abandoned -- To view, visit https://review.coreboot.org/c/coreboot/+/51471 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6324f3cd2213eec7fe1b6f3a4769e79850d2a2f4 Gerrit-Change-Number: 51471 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-MessageType: abandon

1 0

Change in coreboot[master]: Update qc_blobs submodule to upstream master
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has abandoned this change. ( https://review.coreboot.org/c/coreboot/+/51468 ) Change subject: Update qc_blobs submodule to upstream master ...................................................................... Abandoned -- To view, visit https://review.coreboot.org/c/coreboot/+/51468 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: Ieb11ac7208e3f9f1c88c178a429fb9022fe6d5f3 Gerrit-Change-Number: 51468 Gerrit-PatchSet: 2 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-MessageType: abandon

1 0

Change in coreboot[master]: Update opensbi submodule to upstream master
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has abandoned this change. ( https://review.coreboot.org/c/coreboot/+/51467 ) Change subject: Update opensbi submodule to upstream master ...................................................................... Abandoned -- To view, visit https://review.coreboot.org/c/coreboot/+/51467 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I16796abc5ad3c8f99d19ed83c2502d561f24cbbe Gerrit-Change-Number: 51467 Gerrit-PatchSet: 2 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-MessageType: abandon

1 0

Change in coreboot[master]: Update intel-sec-tools submodule to upstream master
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has abandoned this change. ( https://review.coreboot.org/c/coreboot/+/51466 ) Change subject: Update intel-sec-tools submodule to upstream master ...................................................................... Abandoned -- To view, visit https://review.coreboot.org/c/coreboot/+/51466 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: Id47bfe5f239cc6cbde2b857db98f1c22600dbbf6 Gerrit-Change-Number: 51466 Gerrit-PatchSet: 2 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Angel Pons <th3fanbus(a)gmail.com> Gerrit-MessageType: abandon

1 0

Change in coreboot[master]: Update fsp submodule to upstream master
by Martin Roth (Code Review) 05 Apr '21

05 Apr '21

Martin Roth has abandoned this change. ( https://review.coreboot.org/c/coreboot/+/51469 ) Change subject: Update fsp submodule to upstream master ...................................................................... Abandoned -- To view, visit https://review.coreboot.org/c/coreboot/+/51469 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: If293c2c7aa0e0082b7dc90d8177931ae03dcaff5 Gerrit-Change-Number: 51469 Gerrit-PatchSet: 1 Gerrit-Owner: Martin Roth <martinroth(a)google.com> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Angel Pons <th3fanbus(a)gmail.com> Gerrit-MessageType: abandon

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

coreboot-gerrit April 2021