Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Mon, 25 Jul 2022 19:19:53 +0800
From:   kernel test robot <lkp@intel.com>
To:     Sadiya Kazi <sadiyakazi@google.com>, brendanhiggins@google.com,
        davidgow@google.com, skhan@linuxfoundation.org, corbet@lwn.net,
        mairacanal@riseup.net
Cc:     kbuild-all@lists.01.org, Sadiya Kazi <sadiyakazi@google.com>,
        linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3] Documentation: kunit: Add CLI args for kunit_tool
Message-ID: <202207251914.OgQ6lGdw-lkp@intel.com>
References: <20220724184758.1723925-1-sadiyakazi@google.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20220724184758.1723925-1-sadiyakazi@google.com>
Precedence: bulk

Hi Sadiya,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on lwn/docs-next]
[also build test WARNING on linus/master v5.19-rc8 next-20220722]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Sadiya-Kazi/Documentation-kunit-Add-CLI-args-for-kunit_tool/20220725-025055
base:   git://git.lwn.net/linux.git docs-next
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

>> Documentation/dev-tools/kunit/run_wrapper.rst:262: WARNING: Unexpected indentation.

vim +262 Documentation/dev-tools/kunit/run_wrapper.rst

   226	
   227	- ``--help``: Lists all available options. To list common options,
   228	  place ``--help`` before the command. To list options specific to that
   229	  command, place ``--help`` after the command.
   230	
   231	  .. note:: Different commands (``config``, ``build``, ``run``, etc)
   232	            have different supported options.
   233	- ``--build_dir``: Specifies kunit_tool build directory. It includes
   234	  the ``.kunitconfig``, ``.config`` files and compiled kernel.
   235	
   236	- ``--make_options``: Specifies additional options to pass to make, when
   237	  compiling a kernel (using ``build`` or ``run`` commands). For example:
   238	  to enable compiler warnings, we can pass ``--make_options W=1``.
   239	
   240	- ``--alltests``: Builds a UML kernel with all config options enabled
   241	  using ``make allyesconfig``. This allows us to run as many tests as
   242	  possible.
   243	
   244	  .. note:: It is slow and prone to breakage as new options are
   245	            added or modified. Instead, enable all tests
   246	            which have satisfied dependencies by adding
   247	            ``CONFIG_KUNIT_ALL_TESTS=y`` to your ``.kunitconfig``.
   248	
   249	- ``--kunitconfig``: Specifies the path or the directory of the ``.kunitconfig``
   250	  file. For example:
   251	
   252	  - ``lib/kunit/.kunitconfig`` can be the path of the file.
   253	
   254	  - ``lib/kunit`` can be the directory in which the file is located.
   255	
   256	  This file is used to build and run with a predefined set of tests
   257	  and their dependencies. For example, to run tests for a given subsystem.
   258	
   259	- ``--kconfig_add``: Specifies additional configuration options to be
   260	  appended to the ``.kunitconfig`` file. For example:
   261	  .. code-block::
 > 262		./tools/testing/kunit/kunit.py run --kconfig_add CONFIG_KASAN=y
   263	

-- 
0-DAY CI Kernel Test Service
https://01.org/lkp