EditorConfig [0] is an editor-agnostic configuration file, to set preferences on how to edit text: tabs vs. spaces, tab width, indentation size, line endings... A large number of editors support EditorConfig, either natively [1] or with the help of plugins [2]. Add a basic .editorconfig that provides defaults for most of the files used by Buildroot. More can be added in the future if we can find more matching patterns. The values are chosen a bit arbitrarily, unless we already have a (un)written rule about it. Notably, indentation defaults to using 4 spaces, and only a set of files for which we require TABs (Makefile, essentially) or have already settled for TABs (Kconfig files, init scripts...) are configured so. The traditional width of TABs is 8 char, and we pair TAB indentation with TAB size. Trailing spaces are usually useless, except in asciidoc source where they can be used to force a new line without a new paragraph. One of the limitations of .editorconfig, though, is that it matches on filenames (e.g. *.py), not on the content (e.g. no use of mimetype, or libmagic, or such). Still, this is enough to cover a lot of files in Buildroot. [0] https://editorconfig.org/ [1] https://editorconfig.org/#pre-installed [2] https://editorconfig.org/#download Signed-off-by: Yann E. MORIN <yann.morin@orange.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> |
||
---|---|---|
arch | ||
board | ||
boot | ||
configs | ||
docs | ||
fs | ||
linux | ||
package | ||
support | ||
system | ||
toolchain | ||
utils | ||
.checkpackageignore | ||
.clang-format | ||
.defconfig | ||
.editorconfig | ||
.flake8 | ||
.gitignore | ||
.gitlab-ci.yml | ||
.shellcheckrc | ||
CHANGES | ||
Config.in | ||
Config.in.legacy | ||
COPYING | ||
DEVELOPERS | ||
Makefile | ||
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