package/Config.in: explain that lua package names should start with lua
authorArnout Vandecappelle <arnout@mind.be>
Sun, 5 Mar 2017 22:24:42 +0000 (23:24 +0100)
committerThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Mon, 6 Mar 2017 20:20:51 +0000 (21:20 +0100)
We have decided that lua packages should have a name that starts with
lua (like is the case for python and perl). However, we're not going to
rename all the existing lua packages that don't start with lua. This
makes it unclear for people adding packages how they should name the
package, so add a comment to package/Config.in to explain it.

It's rather terse but it gets the message across.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
package/Config.in

index 78acc53718d75a62f6847d8ff9993c2131f9587e..cfe7fc608f1cb341ce1ee8527ba1043d369ebc9b 100644 (file)
@@ -525,6 +525,10 @@ endif
 if BR2_PACKAGE_HAS_LUAINTERPRETER && !BR2_STATIC_LIBS
 # lua modules are dynamically loaded, so not available on static builds
 menu "Lua libraries/modules"
+# When adding lua packages, make sure the name start with "lua". If the
+# upstream package is "luafoo", call it "luafoo" in Buildroot; if the upstream
+# package is "foo", call it "lua-foo". Many packages currently don't follow
+# this convention, but that's historical accident.
        source "package/argparse/Config.in"
        source "package/cgilua/Config.in"
        source "package/copas/Config.in"