[Buildroot] [PATCH] docs/manual: post-image.sh/post-build.sh should use '-', not '_'
"Robert P. J. Day" <[email protected]> Wed, 29 Jul 2026 12:26:54 -0400 (EDT)
| Newsgroups | net.busybox.buildroot |
|---|---|
| Message-ID | <[email protected]> |
Even though it's only documentation, the form of the names of the post-image.sh and post-build.sh scripts should be consistent with the names of those scripts used in the code base, using hyphen, not underscore. Signed-off-by: Robert P. J. Day <[email protected]> --- I can see the chaos that is rootfs_overlay vs rootfs-overlay. Not going near that. diff --git a/docs/manual/customize-directory-structure.adoc b/docs/manual/customize-directory-structure.adoc index b4b5d50e1a..aab225811b 100644 --- a/docs/manual/customize-directory-structure.adoc +++ b/docs/manual/customize-directory-structure.adoc @@ -23,8 +23,8 @@ to you. | +-- linux.config | +-- busybox.config | +-- <other configuration files> -| +-- post_build.sh -| +-- post_image.sh +| +-- post-build.sh +| +-- post-image.sh | +-- rootfs_overlay/ | | +-- etc/ | | +-- <some files> @@ -84,7 +84,7 @@ layers 'common' and 'fooboard' is: +-- board/ +-- <company>/ +-- common/ - | +-- post_build.sh + | +-- post-build.sh | +-- rootfs_overlay/ | | +-- ... | +-- patches/ @@ -94,7 +94,7 @@ layers 'common' and 'fooboard' is: +-- linux.config +-- busybox.config +-- <other configuration files> - +-- post_build.sh + +-- post-build.sh +-- rootfs_overlay/ | +-- ... +-- patches/ diff --git a/docs/manual/customize-quick-guide.adoc b/docs/manual/customize-quick-guide.adoc index 315027c590..360cbe9622 100644 --- a/docs/manual/customize-quick-guide.adoc +++ b/docs/manual/customize-quick-guide.adoc @@ -35,9 +35,9 @@ your project can be skipped. Set +BR2_ROOTFS_OVERLAY+ to +board/<manufacturer>/<boardname>/rootfs-overlay+. . Create a post-build script - +board/<manufacturer>/<boardname>/post_build.sh+. Set + +board/<manufacturer>/<boardname>/post-build.sh+. Set +BR2_ROOTFS_POST_BUILD_SCRIPT+ to - +board/<manufacturer>/<boardname>/post_build.sh+ + +board/<manufacturer>/<boardname>/post-build.sh+ . If additional setuid permissions have to be set or device nodes have to be created, create +board/<manufacturer>/<boardname>/device_table.txt+ and add that path to +BR2_ROOTFS_DEVICE_TABLE+. diff --git a/docs/manual/customize-rootfs.adoc b/docs/manual/customize-rootfs.adoc index 4d03d04617..b7fe5813f7 100644 --- a/docs/manual/customize-rootfs.adoc +++ b/docs/manual/customize-rootfs.adoc @@ -52,7 +52,7 @@ Using post-build scripts, you can remove or modify any file in your post-build cleanup scripts. + As shown in xref:customize-dir-structure[], the recommended path for - this script is +board/<company>/<boardname>/post_build.sh+. + this script is +board/<company>/<boardname>/post-build.sh+. + The post-build scripts are run with the main Buildroot tree as current working directory. The path to the target filesystem is passed as the _______________________________________________ buildroot mailing list [email protected] https://lists.buildroot.org/mailman/listinfo/buildroot