[PATCH RESEND 2/7] Documentation: kunit: align instruction code blocks

From: Bagas Sanjaya
Date: Sun Oct 23 2022 - 09:10:20 EST


Align code blocks in "Writing Your First Test" instructions list so that
these blocks will be rendered at the same level as surrounding
paragraphs in the list.

Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
Documentation/dev-tools/kunit/start.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index 590e25166efb0d..cdf043b6550e66 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -187,13 +187,13 @@ which performs addition of two integers.
a. Create a new header file ``drivers/misc/example.h`` and add the
prototype for ``misc_example_add()``:

-.. code-block:: c
+ .. code-block:: c

int misc_example_add(int left, int right);

b. Write the function implementation in ``drivers/misc/example.c``:

-.. code-block:: c
+ .. code-block:: c

#include <linux/errno.h>

@@ -207,7 +207,7 @@ which performs addition of two integers.
c. In order for the driver to be selected, add configuration entry to
``drivers/misc/Kconfig``:

-.. code-block:: kconfig
+ .. code-block:: kconfig

config MISC_EXAMPLE
bool "My example"
@@ -215,7 +215,7 @@ which performs addition of two integers.
d. Last but not least, append the make goal to ``drivers/misc/Makefile``
so that the driver can be built:

-.. code-block:: make
+ .. code-block:: make

obj-$(CONFIG_MISC_EXAMPLE) += example.o

@@ -224,7 +224,7 @@ which performs addition of two integers.

a. Write the test in ``drivers/misc/example_test.c``:

-.. code-block:: c
+ .. code-block:: c

#include <kunit/test.h>
#include "example.h"
@@ -259,7 +259,7 @@ which performs addition of two integers.

b. Add configuration entry for the test suite to ``drivers/misc/Kconfig``:

-.. code-block:: kconfig
+ .. code-block:: kconfig

config MISC_EXAMPLE_TEST
tristate "Test for my example" if !KUNIT_ALL_TESTS
@@ -268,27 +268,27 @@ which performs addition of two integers.

c. Append make goal for the configuration to ``drivers/misc/Makefile``:

-.. code-block:: make
+ .. code-block:: make

obj-$(CONFIG_MISC_EXAMPLE_TEST) += example_test.o

3. In order to enable the driver and its test suite, append configuration
fragment to ``.kunit/.kunitconfig``:

-.. code-block:: none
+ .. code-block:: none

CONFIG_MISC_EXAMPLE=y
CONFIG_MISC_EXAMPLE_TEST=y

4. Run the test:

-.. code-block:: bash
+ .. code-block:: bash

./tools/testing/kunit/kunit.py run

You should see the following output:

-.. code-block:: none
+ .. code-block:: none

...
[16:08:57] [PASSED] misc-example:misc_example_add_test_basic
--
An old man doll... just what I always wanted! - Clara