kunit: Rename 'kunitconfig' to '.kunitconfig'
authorSeongJae Park <sjpark@amazon.de>
Fri, 20 Dec 2019 05:14:07 +0000 (05:14 +0000)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 23 Dec 2019 17:52:41 +0000 (10:52 -0700)
This commit renames 'kunitconfig' to '.kunitconfig' so that it can be
automatically ignored by git and do not disturb people who want to type
'kernel/' by pressing only the 'k' and then 'tab' key.

Signed-off-by: SeongJae Park <sjpark@amazon.de>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Tested-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/start.rst
tools/testing/kunit/kunit.py
tools/testing/kunit/kunit_kernel.py

index d5197f1..4e1d24d 100644 (file)
@@ -24,18 +24,16 @@ The wrapper can be run with:
 For more information on this wrapper (also called kunit_tool) checkout the
 :doc:`kunit-tool` page.
 
-Creating a kunitconfig
-======================
+Creating a .kunitconfig
+=======================
 The Python script is a thin wrapper around Kbuild. As such, it needs to be
-configured with a ``kunitconfig`` file. This file essentially contains the
+configured with a ``.kunitconfig`` file. This file essentially contains the
 regular Kernel config, with the specific test targets as well.
 
 .. code-block:: bash
 
        cd $PATH_TO_LINUX_REPO
-       cp arch/um/configs/kunit_defconfig kunitconfig
-
-You may want to add kunitconfig to your local gitignore.
+       cp arch/um/configs/kunit_defconfig .kunitconfig
 
 Verifying KUnit Works
 ---------------------
@@ -150,7 +148,7 @@ and the following to ``drivers/misc/Makefile``:
 
        obj-$(CONFIG_MISC_EXAMPLE_TEST) += example-test.o
 
-Now add it to your ``kunitconfig``:
+Now add it to your ``.kunitconfig``:
 
 .. code-block:: none
 
index e4250c4..e59eb9e 100755 (executable)
@@ -108,7 +108,7 @@ def main(argv, linux=None):
                                type=str, default='', metavar='build_dir')
 
        run_parser.add_argument('--defconfig',
-                               help='Uses a default kunitconfig.',
+                               help='Uses a default .kunitconfig.',
                                action='store_true')
 
        cli_args = parser.parse_args(argv)
index a10c0c7..cc5d844 100644 (file)
@@ -14,7 +14,7 @@ import os
 import kunit_config
 
 KCONFIG_PATH = '.config'
-kunitconfig_path = 'kunitconfig'
+kunitconfig_path = '.kunitconfig'
 
 class ConfigError(Exception):
        """Represents an error trying to configure the Linux kernel."""
@@ -111,7 +111,7 @@ class LinuxSourceTree(object):
                return True
 
        def build_reconfig(self, build_dir):
-               """Creates a new .config if it is not a subset of the kunitconfig."""
+               """Creates a new .config if it is not a subset of the .kunitconfig."""
                kconfig_path = get_kconfig_path(build_dir)
                if os.path.exists(kconfig_path):
                        existing_kconfig = kunit_config.Kconfig()