Browse Source

tools: move check-package out of support/scripts/

Move it to the top-level tools/ directory, so that it is easier to
find for users.

Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com>
Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Cc: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Yann E. MORIN 8 years ago
parent
commit
e518b38936

+ 2 - 1
DEVELOPERS

@@ -1391,7 +1391,8 @@ N:	Rhys Williams <github@wilberforce.co.nz>
 F:	package/lirc-tools/
 F:	package/lirc-tools/
 
 
 N:	Ricardo Martincoski <ricardo.martincoski@gmail.com>
 N:	Ricardo Martincoski <ricardo.martincoski@gmail.com>
-F:	support/scripts/check*package*
+F:	tools/check-package
+F:	tools/checkpackagelib/
 
 
 N:	Richard Braun <rbraun@sceen.net>
 N:	Richard Braun <rbraun@sceen.net>
 F:	package/curlftpfs/
 F:	package/curlftpfs/

+ 1 - 1
support/scripts/pkg-stats

@@ -337,7 +337,7 @@ for i in $(find boot/ linux/ package/ toolchain/ -name '*.mk' | sort) ; do
     fi
     fi
 
 
     file_list=$(find ${package_dir} -name '*.mk' -o -name '*.in*' -o -name '*.hash')
     file_list=$(find ${package_dir} -name '*.mk' -o -name '*.in*' -o -name '*.hash')
-    nwarnings=$(./support/scripts/check-package ${file_list} 2>&1 | sed '/\([0-9]*\) warnings generated/!d; s//\1/')
+    nwarnings=$(./tools/check-package ${file_list} 2>&1 | sed '/\([0-9]*\) warnings generated/!d; s//\1/')
     if [ ${nwarnings} -eq 0 ] ; then
     if [ ${nwarnings} -eq 0 ] ; then
 	echo "<td class=\"centered correct\">${nwarnings}</td>"
 	echo "<td class=\"centered correct\">${nwarnings}</td>"
     else
     else

+ 1 - 1
support/scripts/check-package → tools/check-package

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
 #!/usr/bin/env python
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 
 
 from __future__ import print_function
 from __future__ import print_function
 import argparse
 import argparse

+ 0 - 0
support/scripts/checkpackagelib/__init__.py → tools/checkpackagelib/__init__.py


+ 1 - 1
support/scripts/checkpackagelib/base.py → tools/checkpackagelib/base.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 
 
 
 
 class _CheckFunction(object):
 class _CheckFunction(object):

+ 1 - 1
support/scripts/checkpackagelib/lib.py → tools/checkpackagelib/lib.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 
 
 from base import _CheckFunction
 from base import _CheckFunction
 
 

+ 1 - 1
support/scripts/checkpackagelib/lib_config.py → tools/checkpackagelib/lib_config.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 # Kconfig generates errors if someone introduces a typo like "boool" instead of
 # Kconfig generates errors if someone introduces a typo like "boool" instead of
 # "bool", so below check functions don't need to check for things already
 # "bool", so below check functions don't need to check for things already
 # checked by running "make menuconfig".
 # checked by running "make menuconfig".

+ 1 - 1
support/scripts/checkpackagelib/lib_hash.py → tools/checkpackagelib/lib_hash.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 # The validity of the hashes itself is checked when building, so below check
 # The validity of the hashes itself is checked when building, so below check
 # functions don't need to check for things already checked by running
 # functions don't need to check for things already checked by running
 # "make package-dirclean package-source".
 # "make package-dirclean package-source".

+ 1 - 1
support/scripts/checkpackagelib/lib_mk.py → tools/checkpackagelib/lib_mk.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 # There are already dependency checks during the build, so below check
 # There are already dependency checks during the build, so below check
 # functions don't need to check for things already checked by exploring the
 # functions don't need to check for things already checked by exploring the
 # menu options using "make menuconfig" and by running "make" with appropriate
 # menu options using "make menuconfig" and by running "make" with appropriate

+ 1 - 1
support/scripts/checkpackagelib/lib_patch.py → tools/checkpackagelib/lib_patch.py

@@ -1,4 +1,4 @@
-# See support/scripts/checkpackagelib/readme.txt before editing this file.
+# See tools/checkpackagelib/readme.txt before editing this file.
 # The format of the patch files is tested during the build, so below check
 # The format of the patch files is tested during the build, so below check
 # functions don't need to check for things already checked by running
 # functions don't need to check for things already checked by running
 # "make package-dirclean package-patch".
 # "make package-dirclean package-patch".

+ 5 - 5
support/scripts/checkpackagelib/readme.txt → tools/checkpackagelib/readme.txt

@@ -57,19 +57,19 @@ Some hints when changing this code:
 Usage examples:
 Usage examples:
 - to get a list of check functions that would be called without actually
 - to get a list of check functions that would be called without actually
   calling them you can use the --dry-run option:
   calling them you can use the --dry-run option:
-$ support/scripts/check-package --dry-run package/yourfavorite/*
+$ tools/check-package --dry-run package/yourfavorite/*
 
 
 - when you just added a new check function, e.g. Something, check how it behaves
 - when you just added a new check function, e.g. Something, check how it behaves
   for all current packages:
   for all current packages:
-$ support/scripts/check-package --include-only Something $(find package -type f)
+$ tools/check-package --include-only Something $(find package -type f)
 
 
 - the effective processing time (when the .pyc were already generated and all
 - the effective processing time (when the .pyc were already generated and all
   files to be processed are cached in the RAM) should stay in the order of few
   files to be processed are cached in the RAM) should stay in the order of few
   seconds:
   seconds:
-$ support/scripts/check-package $(find package -type f) >/dev/null ; \
-  time support/scripts/check-package $(find package -type f) >/dev/null
+$ tools/check-package $(find package -type f) >/dev/null ; \
+  time tools/check-package $(find package -type f) >/dev/null
 
 
 - vim users can navigate the warnings (most editors probably have similar
 - vim users can navigate the warnings (most editors probably have similar
   function) since warnings are generated in the form 'path/file:line: warning':
   function) since warnings are generated in the form 'path/file:line: warning':
 $ find package/ -name 'Config.*' > filelist && vim -c \
 $ find package/ -name 'Config.*' > filelist && vim -c \
-  'set makeprg=support/scripts/check-package\ $(cat\ filelist)' -c make -c copen
+  'set makeprg=tools/check-package\ $(cat\ filelist)' -c make -c copen

+ 4 - 0
tools/readme.txt

@@ -2,6 +2,10 @@ This directory contains various useful scripts and tools for working
 with Buildroot. You need not add this directory in your PATH to use
 with Buildroot. You need not add this directory in your PATH to use
 any of those tools, but you may do so if you want.
 any of those tools, but you may do so if you want.
 
 
+check-package
+    a script that checks the coding style of a package's Config.in and
+    .mk files, and also tests them for various types of typoes.
+
 get-developpers
 get-developpers
     a script to return the list of people interested in a specific part
     a script to return the list of people interested in a specific part
     of Buildroot, so they can be Cc:ed on a mail. Accepts a patch as
     of Buildroot, so they can be Cc:ed on a mail. Accepts a patch as