Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Swati Sharma <swati2.sharma@intel.com>
To: igt-dev@lists.freedesktop.org
Subject: [igt-dev] [v10 1/5] lib/dsc: fix documentation style
Date: Mon, 18 Sep 2023 11:19:22 +0530	[thread overview]
Message-ID: <20230918054926.238027-2-swati2.sharma@intel.com> (raw)
In-Reply-To: <20230918054926.238027-1-swati2.sharma@intel.com>

Fix documentation style so that it can be detected by scripts
to build IGT reference docs published at
https://drm.pages.freedesktop.org/igt-gpu-tools/

Signed-off-by: Swati Sharma <swati2.sharma@intel.com>
Reviewed-by: Bhanuprakash Modem <bhanuprakash.modem@intel.com>
---
 lib/igt_dsc.c | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/lib/igt_dsc.c b/lib/igt_dsc.c
index 76a420c10..8cb293890 100644
--- a/lib/igt_dsc.c
+++ b/lib/igt_dsc.c
@@ -42,7 +42,7 @@ static int write_dsc_debugfs(int drmfd, char *connector_name, const char *file_n
 	return ret;
 }
 
-/*
+/**
  * igt_is_dsc_supported_by_source:
  * @drmfd: A drm file descriptor
  *
@@ -63,7 +63,7 @@ bool igt_is_dsc_supported_by_source(int drmfd)
 	return res > 0 ? strstr(buf, "has_dsc: yes") : 0;
 }
 
-/*
+/**
  * igt_is_dsc_supported_by_sink:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -75,7 +75,7 @@ bool igt_is_dsc_supported_by_sink(int drmfd, char *connector_name)
 	return check_dsc_debugfs(drmfd, connector_name, "DSC_Sink_Support: yes");
 }
 
-/*
+/**
  * igt_is_fec_supported:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -87,7 +87,7 @@ bool igt_is_fec_supported(int drmfd, char *connector_name)
 	return check_dsc_debugfs(drmfd, connector_name, "FEC_Sink_Support: yes");
 }
 
-/*
+/**
  * igt_is_dsc_enabled:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -99,7 +99,7 @@ bool igt_is_dsc_enabled(int drmfd, char *connector_name)
 	return check_dsc_debugfs(drmfd, connector_name, "DSC_Enabled: yes");
 }
 
-/*
+/**
  * igt_is_force_dsc_enabled:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -112,7 +112,7 @@ bool igt_is_force_dsc_enabled(int drmfd, char *connector_name)
 	return check_dsc_debugfs(drmfd, connector_name, "Force_DSC_Enable: yes");
 }
 
-/*
+/**
  * igt_force_dsc_enable:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -124,7 +124,7 @@ int igt_force_dsc_enable(int drmfd, char *connector_name)
 	return write_dsc_debugfs(drmfd, connector_name, "i915_dsc_fec_support", "1");
 }
 
-/*
+/**
  * igt_force_dsc_enable_bpc:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -141,7 +141,7 @@ int igt_force_dsc_enable_bpc(int drmfd, char *connector_name, int bpc)
 	return write_dsc_debugfs(drmfd, connector_name, "i915_dsc_bpc", buf);
 }
 
-/*
+/**
  * igt_get_dsc_debugfs_fd:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -157,7 +157,7 @@ int igt_get_dsc_debugfs_fd(int drmfd, char *connector_name)
 	return openat(igt_debugfs_dir(drmfd), file_name, O_WRONLY);
 }
 
-/*
+/**
  * igt_is_dsc_output_format_supported_by_sink:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
@@ -188,7 +188,7 @@ bool igt_is_dsc_output_format_supported_by_sink(int drmfd, char *connector_name,
 	return check_dsc_debugfs(drmfd, connector_name, check_str);
 }
 
-/*
+/**
  * igt_force_dsc_output_format:
  * @drmfd: A drm file descriptor
  * @connector_name: Name of the libdrm connector we're going to use
-- 
2.25.1

  reply	other threads:[~2023-09-18  5:48 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-18  5:49 [igt-dev] [v10 0/5] DSC Fractional BPP Val Support Swati Sharma
2023-09-18  5:49 ` Swati Sharma [this message]
2023-09-18  5:49 ` [igt-dev] [v10 2/5] lib/dsc: add helpers for vdsc fractional bpp debugfs entry Swati Sharma
2023-09-18  5:49 ` [igt-dev] [v10 3/5] tests/intel/kms_dsc: enable validation for vdsc fractional bpp Swati Sharma
2023-09-18  5:49 ` [igt-dev] [v10 4/5] tests/intel/kms_dsc: add test to validate fractional bpp with input bpc Swati Sharma
2023-09-18  5:49 ` [igt-dev] [v10 5/5] tests/intel/kms_dsc: remove redundant documentation Swati Sharma
2023-09-18 10:51   ` Juha-Pekka Heikkila
2023-09-18  8:41 ` [igt-dev] ✓ CI.xeBAT: success for DSC Fractional BPP Val Support (rev12) Patchwork
2023-09-18  8:44 ` [igt-dev] ✓ Fi.CI.BAT: " Patchwork
2023-09-19  9:24 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork
2023-09-20  5:01 ` 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=20230918054926.238027-2-swati2.sharma@intel.com \
    --to=swati2.sharma@intel.com \
    --cc=igt-dev@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