From 9a98f50e890b876fb6664bff36783f1afc273312 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Thu, 15 Dec 2016 22:47:44 +0100 Subject: [PATCH] scripts: move to devtools The remaining scripts in the scripts/ directory are only useful to developers. That's why devtools/ is a better name. Signed-off-by: Thomas Monjalon Tested-by: Ferruh Yigit --- MAINTAINERS | 14 +++++++------- {scripts => devtools}/check-git-log.sh | 0 {scripts => devtools}/check-includes.sh | 0 {scripts => devtools}/check-maintainers.sh | 0 {scripts => devtools}/checkpatches.sh | 0 {scripts => devtools}/cocci.sh | 2 +- {scripts => devtools}/cocci/mtod-offset.cocci | 0 {scripts => devtools}/git-log-fixes.sh | 0 {scripts => devtools}/load-devel-config | 0 {scripts => devtools}/test-build.sh | 0 {scripts => devtools}/test-null.sh | 0 {scripts => devtools}/validate-abi.sh | 0 doc/guides/contributing/patches.rst | 8 ++++---- doc/guides/contributing/versioning.rst | 10 +++++----- 14 files changed, 17 insertions(+), 17 deletions(-) rename {scripts => devtools}/check-git-log.sh (100%) rename {scripts => devtools}/check-includes.sh (100%) rename {scripts => devtools}/check-maintainers.sh (100%) rename {scripts => devtools}/checkpatches.sh (100%) rename {scripts => devtools}/cocci.sh (98%) rename {scripts => devtools}/cocci/mtod-offset.cocci (100%) rename {scripts => devtools}/git-log-fixes.sh (100%) rename {scripts => devtools}/load-devel-config (100%) rename {scripts => devtools}/test-build.sh (100%) rename {scripts => devtools}/test-null.sh (100%) rename {scripts => devtools}/validate-abi.sh (100%) diff --git a/MAINTAINERS b/MAINTAINERS index 2e3d7211de..f2c260762d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -24,13 +24,13 @@ General Project Administration M: Thomas Monjalon T: git://dpdk.org/dpdk F: MAINTAINERS -F: scripts/check-maintainers.sh -F: scripts/check-git-log.sh -F: scripts/check-includes.sh -F: scripts/checkpatches.sh -F: scripts/git-log-fixes.sh -F: scripts/load-devel-config -F: scripts/test-build.sh +F: devtools/check-maintainers.sh +F: devtools/check-git-log.sh +F: devtools/check-includes.sh +F: devtools/checkpatches.sh +F: devtools/git-log-fixes.sh +F: devtools/load-devel-config +F: devtools/test-build.sh Stable Branches --------------- diff --git a/scripts/check-git-log.sh b/devtools/check-git-log.sh similarity index 100% rename from scripts/check-git-log.sh rename to devtools/check-git-log.sh diff --git a/scripts/check-includes.sh b/devtools/check-includes.sh similarity index 100% rename from scripts/check-includes.sh rename to devtools/check-includes.sh diff --git a/scripts/check-maintainers.sh b/devtools/check-maintainers.sh similarity index 100% rename from scripts/check-maintainers.sh rename to devtools/check-maintainers.sh diff --git a/scripts/checkpatches.sh b/devtools/checkpatches.sh similarity index 100% rename from scripts/checkpatches.sh rename to devtools/checkpatches.sh diff --git a/scripts/cocci.sh b/devtools/cocci.sh similarity index 98% rename from scripts/cocci.sh rename to devtools/cocci.sh index 7acc256f9c..4ca5025f78 100755 --- a/scripts/cocci.sh +++ b/devtools/cocci.sh @@ -33,7 +33,7 @@ # Apply coccinelle transforms. SRCTREE=$(readlink -f $(dirname $0)/..) -COCCI=$SRCTREE/scripts/cocci +COCCI=$SRCTREE/devtools/cocci [ -n "$SPATCH" ] || SPATCH=$(which spatch) PATCH_LIST="$@" diff --git a/scripts/cocci/mtod-offset.cocci b/devtools/cocci/mtod-offset.cocci similarity index 100% rename from scripts/cocci/mtod-offset.cocci rename to devtools/cocci/mtod-offset.cocci diff --git a/scripts/git-log-fixes.sh b/devtools/git-log-fixes.sh similarity index 100% rename from scripts/git-log-fixes.sh rename to devtools/git-log-fixes.sh diff --git a/scripts/load-devel-config b/devtools/load-devel-config similarity index 100% rename from scripts/load-devel-config rename to devtools/load-devel-config diff --git a/scripts/test-build.sh b/devtools/test-build.sh similarity index 100% rename from scripts/test-build.sh rename to devtools/test-build.sh diff --git a/scripts/test-null.sh b/devtools/test-null.sh similarity index 100% rename from scripts/test-null.sh rename to devtools/test-null.sh diff --git a/scripts/validate-abi.sh b/devtools/validate-abi.sh similarity index 100% rename from scripts/validate-abi.sh rename to devtools/validate-abi.sh diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index c7006c1918..3fd74dbd34 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -298,7 +298,7 @@ For example:: Checking the Patches -------------------- -Patches should be checked for formatting and syntax issues using the ``checkpatches.sh`` script in the ``scripts`` +Patches should be checked for formatting and syntax issues using the ``checkpatches.sh`` script in the ``devtools`` directory of the DPDK repo. This uses the Linux kernel development tool ``checkpatch.pl`` which can be obtained by cloning, and periodically, updating the Linux kernel sources. @@ -313,7 +313,7 @@ files, in order of preference:: Once the environment variable the script can be run as follows:: - scripts/checkpatches.sh ~/patch/ + devtools/checkpatches.sh ~/patch/ The script usage is:: @@ -340,10 +340,10 @@ Where the range is a ``git log`` option. Checking Compilation -------------------- -Compilation of patches and changes should be tested using the the ``test-build.sh`` script in the ``scripts`` +Compilation of patches and changes should be tested using the the ``test-build.sh`` script in the ``devtools`` directory of the DPDK repo:: - scripts/test-build.sh x86_64-native-linuxapp-gcc+next+shared + devtools/test-build.sh x86_64-native-linuxapp-gcc+next+shared The script usage is:: diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 08e2e217d9..fbc44a7940 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -457,7 +457,7 @@ versions of the symbol. Running the ABI Validator ------------------------- -The ``scripts`` directory in the DPDK source tree contains a utility program, +The ``devtools`` directory in the DPDK source tree contains a utility program, ``validate-abi.sh``, for validating the DPDK ABI based on the Linux `ABI Compliance Checker `_. @@ -470,7 +470,7 @@ utilities which can be installed via a package manager. For example:: The syntax of the ``validate-abi.sh`` utility is:: - ./scripts/validate-abi.sh + ./devtools/validate-abi.sh Where ``REV1`` and ``REV2`` are valid gitrevisions(7) https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html @@ -479,13 +479,13 @@ on the local repo and target is the usual DPDK compilation target. For example:: # Check between the previous and latest commit: - ./scripts/validate-abi.sh HEAD~1 HEAD x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linuxapp-gcc # Check between two tags: - ./scripts/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linuxapp-gcc # Check between git master and local topic-branch "vhost-hacking": - ./scripts/validate-abi.sh master vhost-hacking x86_64-native-linuxapp-gcc + ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linuxapp-gcc After the validation script completes (it can take a while since it need to compile both tags) it will create compatibility reports in the -- 2.20.1