docs/manual/customize-rootfs.txt

1 // -*- mode:doc; -*-
4 [[rootfs-custom]]
10 The two recommended methods, which can co-exist, are root filesystem
11 overlay(s) and post build script(s).
19   multiple overlays, space-separated. If you specify a relative path,
31 As shown in xref:customize-dir-structure[], the recommended path for
32   this overlay is +board/<company>/<boardname>/rootfs-overlay+.
34 Post-build scripts (+BR2_ROOTFS_POST_BUILD_SCRIPT+)::
36 Post-build scripts are shell scripts called 'after' Buildroot builds
38   assembled. To enable this feature, specify a space-separated list of
39   post-build scripts in config option +BR2_ROOTFS_POST_BUILD_SCRIPT+ (in
43 Using post-build scripts, you can remove or modify any file in your
47   post-build cleanup scripts.
49 As shown in xref:customize-dir-structure[], the recommended path for
52 The post-build scripts are run with the main Buildroot tree as current
62   - +BR2_CONFIG+: the path to the Buildroot .config file
63   - +CONFIG_DIR+: the directory containing the .config file, and
64     therefore the top-level Buildroot Makefile to use (which is
65     correct for both in-tree and out-of-tree builds)
66   - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
67     xref:generic-package-reference[]
68   - +BUILD_DIR+: the directory where packages are extracted and built
69   - +BINARIES_DIR+: the place where all binary files (aka images) are
71   - +BASE_DIR+: the base output directory
86   refer to xref:full-rebuild[] for details. This solution is therefore
90   overlay or a post-build script.
102   post-build script to adapt it. However, if the default skeleton is
125 Post-fakeroot scripts (+BR2_ROOTFS_POST_FAKEROOT_SCRIPT+)::
134 Post-fakeroot scripts are shell scripts that are called at the 'end' of
138 Post-fakeroot scripts can be useful in case you need to tweak the
144   or create entries in `/dev` (see xref:customize-device-permission[]) or
145   to create users (see xref:customize-users[])
148 The difference between post-build scripts (above) and fakeroot scripts,
149   is that post-build scripts are not called in the fakeroot context.
154   block-or-char device...) and uid/gid; these are emulated in-memory.
156 include::customize-device-permission-tables.txt[]