Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Lyude <lyude@redhat.com>
To: igt-dev@lists.freedesktop.org
Cc: nouveau@lists.freedesktop.org
Subject: [igt-dev] [PATCH i-g-t v5 1/5] lib/igt_core: Fix igt_assert_fd() documentation
Date: Wed, 30 Sep 2020 13:31:46 -0400	[thread overview]
Message-ID: <20200930173150.431995-2-lyude@redhat.com> (raw)
In-Reply-To: <20200930173150.431995-1-lyude@redhat.com>

From: Lyude Paul <lyude@redhat.com>

As Petri Latvala pointed out, some of the documentation in this macro is
mistakenly copied from the other igt_assert*() macros. Let's fix that.

Signed-off-by: Lyude Paul <lyude@redhat.com>
---
 lib/igt_core.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/igt_core.h b/lib/igt_core.h
index c5871520..e74ede8b 100644
--- a/lib/igt_core.h
+++ b/lib/igt_core.h
@@ -966,8 +966,8 @@ void igt_describe_f(const char *fmt, ...);
  *
  * Fails (sub-) test if the given file descriptor is invalid.
  *
- * Like igt_assert(), but displays the values being compared on failure instead
- * of simply printing the stringified expression.
+ * Like igt_assert(), but displays the stringified identifier that was supposed
+ * to contain a valid fd on failure.
  */
 #define igt_assert_fd(fd) \
 	igt_assert_f(fd >= 0, "file descriptor " #fd " failed\n");
-- 
2.26.2

_______________________________________________
igt-dev mailing list
igt-dev@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/igt-dev

  reply	other threads:[~2020-09-30 17:32 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-30 17:31 [igt-dev] [PATCH i-g-t v5 0/5] Add nouveau-crc tests Lyude
2020-09-30 17:31 ` Lyude [this message]
2020-10-01  6:49   ` [igt-dev] [PATCH i-g-t v5 1/5] lib/igt_core: Fix igt_assert_fd() documentation Petri Latvala
2020-09-30 17:31 ` [igt-dev] [PATCH i-g-t v5 2/5] lib/igt_core: Add igt_require_fd() Lyude
2020-10-01  6:50   ` Petri Latvala
2020-09-30 17:31 ` [igt-dev] [PATCH i-g-t v5 3/5] lib/igt_debugfs: Add igt_debugfs_pipe_dir() Lyude
2020-09-30 17:31 ` [igt-dev] [PATCH i-g-t v5 4/5] lib/igt_kms: Hook up connector dithering prop Lyude
2020-09-30 17:31 ` [igt-dev] [PATCH i-g-t v5 5/5] tests: Add nouveau-crc tests Lyude
2020-09-30 18:32   ` Jeremy Cline
2020-09-30 18:33 ` [igt-dev] [PATCH i-g-t v5 0/5] " Jeremy Cline
2020-09-30 19:05 ` [igt-dev] ✓ Fi.CI.BAT: success for Add nouveau-crc tests (rev5) Patchwork
2020-09-30 22:59 ` [igt-dev] ✗ Fi.CI.IGT: failure " 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=20200930173150.431995-2-lyude@redhat.com \
    --to=lyude@redhat.com \
    --cc=igt-dev@lists.freedesktop.org \
    --cc=nouveau@lists.freedesktop.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox