[PATCH libevdev 4/4] doc: move the section for the internal test suite down

[Benjamin Tissoires]

On Tue, Mar 11, 2014 at 8:45 PM, Peter Hutterer
<peter.hutterer at who-t.net> wrote:
> "Related Pages" in doxygen are ordered in the order they appear in the source
> file. The internal test suite is least likely to be of interest to the
> reader, so move it to the bottom.
>
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---

For the whole series:
Reviewed-by: Benjamin Tissoires <benjamin.tissoires at gmail.com>

>  libevdev/libevdev.h | 92 ++++++++++++++++++++++++++---------------------------
>  1 file changed, 46 insertions(+), 46 deletions(-)
>
> diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h
> index d5c7515..8cf7764 100644
> --- a/libevdev/libevdev.h
> +++ b/libevdev/libevdev.h
> @@ -309,52 +309,6 @@ extern "C" {
>   */
>
>  /**
> - * @page testing libevdev-internal test suite
> - *
> - * libevdev's internal test suite uses the
> - * [Check unit testing framework](http://check.sourceforge.net/). Tests are
> - * divided into test suites and test cases. Most tests create a uinput device,
> - * so you'll need to run as root.
> - *
> - * To run a specific suite only:
> - *
> - *     export CK_RUN_SUITE="suite name"
> - *
> - * To run a specific test case only:
> - *
> - *     export CK_RUN_TEST="test case name"
> - *
> - * To get a list of all suites or tests:
> - *
> - *     git grep "suite_create"
> - *     git grep "tcase_create"
> - *
> - * By default, Check forks, making debugging harder. The test suite tries to detect
> - * if it is running inside gdb and disable forking. If that doesn't work for
> - * some reason, run gdb as below to avoid forking.
> - *
> - *     sudo CK_FORK=no CK_RUN_TEST="test case name" gdb ./test/test-libevdev
> - *
> - * A special target `make gcov-report.txt` exists that runs gcov and leaves a
> - * `libevdev.c.gcov` file. Check that for test coverage.
> - *
> - * `make check` is hooked up to run the test and gcov (again, needs root).
> - *
> - * The test suite creates a lot of devices, very quickly. Add the following
> - * xorg.conf.d snippet to avoid the devices being added as X devices (at the
> - * time of writing, mutter can't handle these devices and exits after getting
> - * a BadDevice error).
> - *
> - *     $ cat /etc/X11/xorg.conf.d/99-ignore-libevdev-devices.conf
> - *     Section "InputClass"
> - *             Identifier "Ignore libevdev test devices"
> - *             MatchProduct "libevdev test device"
> - *             Option "Ignore" "on"
> - *     EndSection
> - *
> - */
> -
> -/**
>   * @page backwardscompatibility Compatibility and Behavior across kernel versions
>   *
>   * This page describes libevdev's behavior when the build-time kernel and the
> @@ -478,6 +432,52 @@ extern "C" {
>   */
>
>  /**
> + * @page testing libevdev-internal test suite
> + *
> + * libevdev's internal test suite uses the
> + * [Check unit testing framework](http://check.sourceforge.net/). Tests are
> + * divided into test suites and test cases. Most tests create a uinput device,
> + * so you'll need to run as root.
> + *
> + * To run a specific suite only:
> + *
> + *     export CK_RUN_SUITE="suite name"
> + *
> + * To run a specific test case only:
> + *
> + *     export CK_RUN_TEST="test case name"
> + *
> + * To get a list of all suites or tests:
> + *
> + *     git grep "suite_create"
> + *     git grep "tcase_create"
> + *
> + * By default, Check forks, making debugging harder. The test suite tries to detect
> + * if it is running inside gdb and disable forking. If that doesn't work for
> + * some reason, run gdb as below to avoid forking.
> + *
> + *     sudo CK_FORK=no CK_RUN_TEST="test case name" gdb ./test/test-libevdev
> + *
> + * A special target `make gcov-report.txt` exists that runs gcov and leaves a
> + * `libevdev.c.gcov` file. Check that for test coverage.
> + *
> + * `make check` is hooked up to run the test and gcov (again, needs root).
> + *
> + * The test suite creates a lot of devices, very quickly. Add the following
> + * xorg.conf.d snippet to avoid the devices being added as X devices (at the
> + * time of writing, mutter can't handle these devices and exits after getting
> + * a BadDevice error).
> + *
> + *     $ cat /etc/X11/xorg.conf.d/99-ignore-libevdev-devices.conf
> + *     Section "InputClass"
> + *             Identifier "Ignore libevdev test devices"
> + *             MatchProduct "libevdev test device"
> + *             Option "Ignore" "on"
> + *     EndSection
> + *
> + */
> +
> +/**
>   * @defgroup init Initialization and setup
>   *
>   * Initialization, initial setup and file descriptor handling.
> --
> 1.8.5.3
>
> _______________________________________________
> Input-tools mailing list
> Input-tools at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/input-tools