All of lore.kernel.org
 help / color / mirror / Atom feed
From: Tales Aparecida <tales.aparecida@gmail.com>
To: igt-dev@lists.freedesktop.org, Chris Wilson <chris@chris-wilson.co.uk>
Cc: siqueirajordao@riseup.net, magalilemes00@gmail.com,
	tales.aparecida@gmail.com, Isabella Basso <isabbasso@riseup.net>,
	andrealmeid@riseup.net, Trevor Woerner <twoerner@gmail.com>
Subject: [igt-dev] [PATCH i-g-t 0/4] add kselftest runner documentation
Date: Wed,  3 Aug 2022 02:26:50 -0300	[thread overview]
Message-ID: <20220803052654.98827-1-tales.aparecida@gmail.com> (raw)

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

             reply	other threads:[~2022-08-03  5:27 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-03  5:26 Tales Aparecida [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220803052654.98827-1-tales.aparecida@gmail.com \
    --to=tales.aparecida@gmail.com \
    --cc=andrealmeid@riseup.net \
    --cc=chris@chris-wilson.co.uk \
    --cc=igt-dev@lists.freedesktop.org \
    --cc=isabbasso@riseup.net \
    --cc=magalilemes00@gmail.com \
    --cc=siqueirajordao@riseup.net \
    --cc=twoerner@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.