Warn the user about the usage of output/target as the root filesystem
authorThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Sat, 17 Nov 2012 03:52:14 +0000 (03:52 +0000)
committerPeter Korsgaard <jacmet@sunsite.dk>
Sat, 17 Nov 2012 16:12:49 +0000 (17:12 +0100)
commit9226a9907c4eb0fffab777f50e88b74aa14d1737
tree10f2f5d570f20e6643aa60a0148947c28cbe6cfa
parentee3a96137b6cbb8f970c540c61f75300a44ea803
Warn the user about the usage of output/target as the root filesystem

A very common mistake done by our users is that they use
output/target/ directory as their root filesystem. Even though this is
loudly documented in our Buildroot manual, people don't read
documentation, so it is not sufficient.

This patch adds a text file named
output/target/THIS_IS_NOT_YOUR_ROOT_FILESYSTEM which explains why
output/target isn't appropriate to use as the root filesystem. The
process is:

 * At the beginning of the build, right after the skeleton has been
   copied, support/misc/target-dir-warning.txt is copied to
   output/target/THIS_IS_NOT_YOUR_ROOT_FILESYSTEM

 * In the filesystem images creation code, this file is removed before
   launching fakeroot, and restored right after that, so that this
   file is not present in the generated root filesystem images.

Note that the file has not been added to the default skeleton for two
reasons:

 * It would have annoying to have in our source tree a file named in
   capital letters inside system/skeleton/

 * The proposed way works even if the user uses a custom skeleton.

[Peter: fixed typo]
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Juha Lumme <juha.lumme@gmail.com>
Acked-by: Gustavo Zacarias <gustavo@zacarias.com.ar>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
Makefile
fs/common.mk
support/misc/target-dir-warning.txt [new file with mode: 0644]