Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [igt-dev] [PATCH i-g-t v3 0/4] add kselftest runner documentation
@ 2022-08-15 14:51 Tales Aparecida
  2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 1/4] lib/igt_kmod: fix trivial typos Tales Aparecida
                   ` (6 more replies)
  0 siblings, 7 replies; 11+ messages in thread
From: Tales Aparecida @ 2022-08-15 14:51 UTC (permalink / raw)
  To: Petri Latvala, igt-dev
  Cc: siqueirajordao, magalilemes00, tales.aparecida, Isabella Basso,
	andrealmeid, Trevor Woerner

In the interest of making the code more accessible, add documentation
on structs and functions related to the kselftest.
As an extra, add instructions about writing documentation and fixes
igt_kselftest_begin() always returning zero.

# Changelog (https://patchwork.freedesktop.org/series/106921/)

## v2 -> v3:

- Rebased the series

- In the third patch, inside igt_kselftest_begin(), replace igt_assert_fd()
with igt_require_fd()  to skip tests instead of failing, which would imply
there's a problem with the kernel. Suggested by Petri Latvala <petri.latvala@intel.com>.

- In the 4th patch, rephrase igt_kselftest_begin() documentation to say "skips"
instead of "fails"

## v1 -> v2:

- Added R-b in the 1st patch

- Moved gtkdoc link above igt_require to match occurrence in text in
the 2nd patch

- In the 3rd patch, instead of returning non-zero in the function
igt_kselftest_begin() from errors while opening /dev/kmsg, assert a
success and skip the whole kselftest on failures.

- Fix code style issues in the 4th patch

Tales Aparecida (4):
  lib/igt_kmod: fix trivial typos
  CONTRIBUTING: Add reference for GTKDoc
  lib/kselftests: Skip kselftest when opening kmsg fails
  lib/igt_kmod: add igt_kselftests documentation

 CONTRIBUTING.md |   7 +++
 lib/igt_kmod.c  | 120 +++++++++++++++++++++++++++++++++++++++++++++---
 lib/igt_kmod.h  |  20 +++++++-
 3 files changed, 140 insertions(+), 7 deletions(-)


base-commit: d47beef9b01595f721c584070940c95be1cf11e8
-- 
2.37.1

^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2022-08-16  2:39 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-08-15 14:51 [igt-dev] [PATCH i-g-t v3 0/4] add kselftest runner documentation Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 1/4] lib/igt_kmod: fix trivial typos Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 2/4] CONTRIBUTING: Add reference for GTKDoc Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 3/4] lib/kselftests: Skip kselftest when opening kmsg fails Tales Aparecida
2022-08-15 14:51 ` [igt-dev] [PATCH i-g-t v3 4/4] lib/igt_kmod: add igt_kselftests documentation Tales Aparecida
2022-08-15 16:46   ` André Almeida
2022-08-15 17:20     ` Tales
2022-08-15 17:23       ` André Almeida
2022-08-15 16:35 ` [igt-dev] [PATCH i-g-t v3 2/4] CONTRIBUTING: Add reference for GTKDoc Tales Aparecida
2022-08-15 17:54 ` [igt-dev] ✓ Fi.CI.BAT: success for add kselftest runner documentation (rev3) Patchwork
2022-08-16  2:39 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox