Go to file
Yann E. MORIN 467917e2da package/pkg-utils: introduce helper to properly json-escape a string
In quite a few places, we need to generate string that are proper JSON
values or keys.

However, JSON is very strict on what constitute a string, and most JSON
parsers (like jq or python3's json module) are very picky when parsing a
string; any deviation from the spec is immediately sanctioned by a hard
error (jq aborts, python3's json module raise an exception).

Introduce a macro that properly prepares a Makefile value into a valid
JSON string:

  - backslash '\' must be escaped;

  - double-quotes need to be escaped of course, as they are the string
    delimiter in JSON;

  - anything in the range [0x00..0x1F] must be escaped; in practice, we
    only ever need to escape \n, \t, and ESC (we could add more in the
    future if need be);

  - finally, we also escape the space, \x20, so that we can call
    $(strip) on a JSON blurb (like we do for example do build a
    comma-separated list, or when we sanitise the JSON) without losing
    multiple spaces where they make sense.

It would have been nice if we had been able to split the macro on
multiple lines, but spaces creep in from everywhere in that case, and
getting rid of them is getting quite nasty... We could introduce
intermediate macros, but meh...

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2021-12-30 21:32:33 +01:00
arch
board configs/imx6ulpico: bump U-Boot and kernel, switch to extlinux.conf 2021-12-29 23:53:16 +01:00
boot boot/barebox: bump version to 2021.12.0 2021-12-30 21:15:57 +01:00
configs configs/imx6ulpico: bump U-Boot and kernel, switch to extlinux.conf 2021-12-29 23:53:16 +01:00
docs
fs
linux
package package/pkg-utils: introduce helper to properly json-escape a string 2021-12-30 21:32:33 +01:00
support support/misc/utils: introduce $(tab)=\t and $(escape)=\x1b 2021-12-30 21:31:27 +01:00
system
toolchain toolchain: re-generate Bootlin toolchain descriptions 2021-12-30 18:43:23 +01:00
utils
.defconfig
.flake8
.gitignore
.gitlab-ci.yml
CHANGES
Config.in
Config.in.legacy toolchain: re-generate Bootlin toolchain descriptions 2021-12-30 18:43:23 +01:00
COPYING
DEVELOPERS
Makefile Makefile: set HOST*_NOCCACHE variables only if unset 2021-12-29 10:11:27 +01:00
Makefile.legacy
README

Buildroot is a simple, efficient and easy-to-use tool to generate embedded
Linux systems through cross-compilation.

The documentation can be found in docs/manual. You can generate a text
document with 'make manual-text' and read output/docs/manual/manual.text.
Online documentation can be found at http://buildroot.org/docs.html

To build and use the buildroot stuff, do the following:

1) run 'make menuconfig'
2) select the target architecture and the packages you wish to compile
3) run 'make'
4) wait while it compiles
5) find the kernel, bootloader, root filesystem, etc. in output/images

You do not need to be root to build or run buildroot.  Have fun!

Buildroot comes with a basic configuration for a number of boards. Run
'make list-defconfigs' to view the list of provided configurations.

Please feed suggestions, bug reports, insults, and bribes back to the
buildroot mailing list: buildroot@buildroot.org
You can also find us on #buildroot on OFTC IRC.

If you would like to contribute patches, please read
https://buildroot.org/manual.html#submitting-patches