mirror of
https://github.com/apache/nuttx.git
synced 2026-10-08 14:55:18 +00:00
f6ecf80ebb
The documentation grew one page at a time, so the tree follows the
history of who wrote what and not the shape of NuttX. Scheduling is
spread over three places, a driver page can sit above the subsystem
that owns it, and the front page lists everything at the same level.
That is a lot to face when all you want to know is where the scheduler
lives.
This change files every page under the code it describes. It is a move,
not a rewrite: outside the ten pages named below, every page keeps the
text that is already in master, and no page's text is deleted.
What it does:
* Groups the table of contents into nine chapters.
* Moves the OS subsystems under os/: scheduling, memory, drivers,
filesystem, networking, IPC, interrupts, libs, time.
* Renames the platform pages to the names the source tree uses, and
derives their tags from the tree instead of by hand.
* Splits guides/ by subject.
* Adds Documentation/redirects.py, with a rule for every page that left
its old path, so old URLs keep working. The redirect page also carries
a link's #anchor across to the new page.
Ten pages have text that is new or rewritten. Nine of them are the
landing page of a chapter, which has to exist for the new structure:
index the front page
os/index OS Design
os/scheduling/index Scheduling
os/interrupts/index Interrupts
os/ipc/index IPC
os/time/index Time and timers
about/index About
developing/index Developing NuttX
ReleaseNotes/index Release notes
The tenth is os/libs/libbuiltin, the only page here with technical
content: libs/libbuiltin/ had no page at all. Five SVG diagrams come
with these pages, hand-written XML with no editor metadata.
Nothing outside Documentation/ is touched.
How it was checked:
* Sphinx builds with -W: no warnings, and no document left outside a
toctree.
* A script, offered in the PR, proves the narrow claim this rests on.
For every page outside the ten named above it erases what a move
touches -- link target, path, tag line, toctree block, table border --
from the whole old text and the whole new text, and requires the two
to be byte for byte identical. It also requires every sentence of a
deleted page to turn up somewhere, and every page that left its old
path to have a redirect, from a URL that existed, to where its content
went. It exits non-zero and names the page if any of that is not true,
and it tests added pages too, so forgetting to declare one cannot make
it pass.
* An independent audit checked 133 factual claims on these ten pages
against the tree, one shell command per claim: 130 confirmed, 1
refuted and fixed here, 2 not checkable.
* tools/checkpatch.sh is clean over the range.
The diff is large because moving a page changes every link that points
to it. Most of it is pure renames, and board pages that gained one tag
line.
Assisted-by: Claude:claude-opus-5
83 lines
2.4 KiB
ReStructuredText
83 lines
2.4 KiB
ReStructuredText
=================================
|
|
``unity`` Unity testing framework
|
|
=================================
|
|
|
|
Unity is a unit testing framework for C developed by ThrowTheSwitch.org:
|
|
|
|
http://www.throwtheswitch.org/unity
|
|
|
|
.. note::
|
|
|
|
There is more detailed documentation than what can be found on the website on
|
|
the GitHub page. It can be found in `this collection of markdown
|
|
documents <https://github.com/ThrowTheSwitch/Unity/tree/master/docs>`_
|
|
|
|
It is very minimalist and is designed to also run on embedded systems. Unity is
|
|
highly configurable through the use of different macros. These are described in
|
|
the `configuration guide
|
|
<https://github.com/ThrowTheSwitch/Unity/blob/master/docs/UnityConfigurationGuide.md>`_.
|
|
Some of these configuration options are exposed in NuttX via the Kconfig
|
|
selection menu for the Unity test framework, but not all of them are
|
|
implemented.
|
|
|
|
.. note::
|
|
|
|
If some configuration options you'd like to use for Unity are missing from
|
|
NuttX, please open a pull request following the :doc:`contribution guidelines
|
|
</contributing/index>`.
|
|
|
|
|
|
Usage
|
|
=====
|
|
|
|
In order to test your application using the Unity framework in NuttX, you can
|
|
create a test application. Documentation for creating a custom NuttX application
|
|
can be found :doc:`here </guides/build/customapps>`.
|
|
|
|
Just mark your application to depend on any Unity options you use:
|
|
|
|
.. code-block:: kconfig
|
|
|
|
config MY_TESTS
|
|
tristate "Test cases"
|
|
depends on TESTING_UNITY
|
|
depends on TESTING_UNITY_EXCLUDE_SETJMP
|
|
depends on TESTING_UNITY_PRINT_FORMATTED
|
|
depends on MY_APPLICATION_CODE
|
|
|
|
In your application's main function, you can include the testing library and
|
|
write tests!
|
|
|
|
.. code-block:: c
|
|
|
|
#include <testing/unity.h>
|
|
|
|
void setUp(void) { /* Test setup code for Unity */ }
|
|
void tearDown(void) { /* Test tear-down code for Unity */ }
|
|
|
|
/* Short test case */
|
|
|
|
static void test_mything__passes(void)
|
|
{
|
|
int mynum = 0;
|
|
mynum++;
|
|
TEST_ASSERT_EQUAL(1, mynum);
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
UNITY_BEGIN();
|
|
RUN_TEST(test_mything__passes);
|
|
return UNITY_END();
|
|
}
|
|
|
|
Now when you build your code, your test application will be visible in NSH to
|
|
run. If you run it, you will see a test report!
|
|
|
|
.. code-block:: console
|
|
|
|
nsh> mytests
|
|
mytests_main.c:18:test_mything__passes:PASS
|
|
|
|
-----------------------
|
|
1 Tests 0 Failures 0 Ignored
|