All of lore.kernel.org
 help / color / mirror / Atom feed
* [igt-dev] [PATCH i-g-t 0/4] add kselftest runner documentation
@ 2022-08-03  5:26 Tales Aparecida
  2022-08-03  5:26 ` [igt-dev] [PATCH i-g-t 1/4] lib/igt_kmod: fix trivial typos Tales Aparecida
                   ` (5 more replies)
  0 siblings, 6 replies; 13+ messages in thread
From: Tales Aparecida @ 2022-08-03  5:26 UTC (permalink / raw)
  To: igt-dev, Chris Wilson
  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.
While writing igt_kselftest_begin() documentation I realized it always
returned 0. Instead of documenting that behavior, the function now
returns non-zero if it fails to open /dev/kmsg.

As an extra, add instructions about writing documentation.

Tales Aparecida (4):
  lib/igt_kmod: fix trivial typos
  CONTRIBUTING: Add reference for GTKDoc
  lib/kselftests: return non-zero on open(kmsg) failure
  lib/igt_kmod: add igt_kselftests documentation

 CONTRIBUTING.md |   7 +++
 lib/igt_kmod.c  | 113 +++++++++++++++++++++++++++++++++++++++++++++++-
 lib/igt_kmod.h  |  18 ++++++++
 3 files changed, 136 insertions(+), 2 deletions(-)

-- 
2.37.0

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

end of thread, other threads:[~2022-08-04 18:09 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-08-03  5:26 [igt-dev] [PATCH i-g-t 0/4] add kselftest runner documentation Tales Aparecida
2022-08-03  5:26 ` [igt-dev] [PATCH i-g-t 1/4] lib/igt_kmod: fix trivial typos Tales Aparecida
2022-08-03 17:13   ` Kamil Konieczny
2022-08-03  5:26 ` [igt-dev] [PATCH i-g-t 2/4] CONTRIBUTING: Add reference for GTKDoc Tales Aparecida
2022-08-03  5:26 ` [igt-dev] [PATCH i-g-t 3/4] lib/kselftests: return non-zero on open(kmsg) failure Tales Aparecida
2022-08-03 17:11   ` Kamil Konieczny
2022-08-03 20:04     ` Tales
2022-08-04 18:09   ` Maíra Canal
2022-08-03  5:26 ` [igt-dev] [PATCH i-g-t 4/4] lib/igt_kmod: add igt_kselftests documentation Tales Aparecida
2022-08-03  8:47   ` Petri Latvala
2022-08-03 15:49     ` Tales
2022-08-03  6:00 ` [igt-dev] ✓ Fi.CI.BAT: success for add kselftest runner documentation Patchwork
2022-08-03 13:29 ` [igt-dev] ✓ Fi.CI.IGT: " Patchwork

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.