From: Lee Jones <lee@kernel.org>
To: lee@kernel.org
Cc: intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org,
dri-devel@lists.freedesktop.org, Daniel Vetter <daniel@ffwll.ch>,
Rodrigo Vivi <rodrigo.vivi@intel.com>,
David Airlie <airlied@gmail.com>
Subject: [Intel-gfx] [PATCH 08/19] drm/i915/gem/i915_gem_domain: Provide function names to complete proper kerneldoc
Date: Fri, 31 Mar 2023 10:25:56 +0100 [thread overview]
Message-ID: <20230331092607.700644-9-lee@kernel.org> (raw)
In-Reply-To: <20230331092607.700644-1-lee@kernel.org>
Fixes the following W=1 kernel build warning(s):
drivers/gpu/drm/i915/gem/i915_gem_domain.c:119: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/i915/gem/i915_gem_domain.c:180: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/i915/gem/i915_gem_domain.c:265: warning: expecting prototype for Changes the cache(). Prototype was for i915_gem_object_set_cache_level() instead
drivers/gpu/drm/i915/gem/i915_gem_domain.c:470: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/i915/gem/i915_gem_domain.c:514: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>
Cc: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: intel-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee@kernel.org>
---
drivers/gpu/drm/i915/gem/i915_gem_domain.c | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/drivers/gpu/drm/i915/gem/i915_gem_domain.c b/drivers/gpu/drm/i915/gem/i915_gem_domain.c
index 497de40b8e688..d2d5a24301b25 100644
--- a/drivers/gpu/drm/i915/gem/i915_gem_domain.c
+++ b/drivers/gpu/drm/i915/gem/i915_gem_domain.c
@@ -116,7 +116,8 @@ void i915_gem_object_flush_if_display_locked(struct drm_i915_gem_object *obj)
}
/**
- * Moves a single object to the WC read, and possibly write domain.
+ * i915_gem_object_set_to_wc_domain - Moves a single object to the WC read, and
+ * possibly write domain.
* @obj: object to act on
* @write: ask for write access or read only
*
@@ -177,7 +178,8 @@ i915_gem_object_set_to_wc_domain(struct drm_i915_gem_object *obj, bool write)
}
/**
- * Moves a single object to the GTT read, and possibly write domain.
+ * i915_gem_object_set_to_gtt_domain - Moves a single object to the GTT read,
+ * and possibly write domain.
* @obj: object to act on
* @write: ask for write access or read only
*
@@ -246,7 +248,7 @@ i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj, bool write)
}
/**
- * Changes the cache-level of an object across all VMA.
+ * i915_gem_object_set_cache_level - Changes the cache-level of an object across all VMA.
* @obj: object to act on
* @cache_level: new cache level to set for the object
*
@@ -467,7 +469,8 @@ i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj,
}
/**
- * Moves a single object to the CPU read, and possibly write domain.
+ * i915_gem_object_set_to_cpu_domain - Moves a single object to the CPU read,
+ * and possibly write domain.
* @obj: object to act on
* @write: requesting write or read-only access
*
@@ -511,7 +514,8 @@ i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write)
}
/**
- * Called when user space prepares to use an object with the CPU, either
+ * i915_gem_set_domain_ioctl - Called when user space prepares to use an
+ * object with the CPU, either
* through the mmap ioctl's mapping or a GTT mapping.
* @dev: drm device
* @data: ioctl data blob
--
2.40.0.348.gf938b09366-goog
next prev parent reply other threads:[~2023-03-31 12:10 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20230331092607.700644-1-lee@kernel.org>
2023-03-31 9:25 ` [Intel-gfx] [PATCH 01/19] drm/i915/i915_scatterlist: Fix kerneldoc formatting issue - missing '@' Lee Jones
2023-04-03 15:35 ` Jani Nikula
2023-04-03 16:20 ` Lee Jones
2023-04-04 9:44 ` Jani Nikula
2023-04-05 13:45 ` Lee Jones
2023-04-05 16:06 ` Jani Nikula
2023-04-05 16:41 ` Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 02/19] drm/i915/intel_region_ttm: Provide missing description for 'offset' param Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 04/19] drm/i915/display/intel_display_debugfs: Fix incorrect param naming for 'intel_connector' Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 05/19] drm/i915/gt/intel_engine_cs: Fix a couple of incorrectly named functions Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 06/19] drm/i915/gt/intel_rps: Demote a kerneldoc abuse for ips_ping_for_i915_load() Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 07/19] drm/i915/gem/i915_gem_create: Provide the function names for proper kerneldoc headers Lee Jones
2023-03-31 15:18 ` kernel test robot
2023-03-31 9:25 ` Lee Jones [this message]
2023-03-31 9:25 ` [Intel-gfx] [PATCH 09/19] drm/i915/gem/i915_gem_ttm_pm: Provide a couple of missing descriptions for 'flags' and remove some superfluous ones Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 10/19] drm/i915/gem/i915_gem_ttm: Demote half-filled kerneldoc Lee Jones
2023-03-31 9:25 ` [Intel-gfx] [PATCH 11/19] drm/i915/gem/i915_gem_ttm_move: Provide a couple of missing descriptions for 'num_pages' and 'ctx' Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 12/19] drm/i915/gem/i915_gem_wait: Provide function name to validate the kerneldoc header Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 13/19] drm/i915/gem/i915_gem_object: Demote non-kerneldoc header with no param descriptions Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 14/19] drm/i915/i915_gem: Provide function names to complete the expected kerneldoc format Lee Jones
2023-03-31 17:52 ` kernel test robot
2023-03-31 9:26 ` [Intel-gfx] [PATCH 15/19] drm/i915/gt/uc/intel_guc_hwconfig: Demote a few non-conforming kerneldoc headers Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 16/19] drm/i915/i915_vma: Provide one missing param and demote another non-kerneldoc header Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 17/19] drm/i915/display/intel_display_power: Fix incorrectly documented function __intel_display_power_put_async() Lee Jones
2023-03-31 9:26 ` [Intel-gfx] [PATCH 19/19] drm/i915/display/intel_wm: Fix a little doc-rot in intel_update_watermarks() Lee Jones
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=20230331092607.700644-9-lee@kernel.org \
--to=lee@kernel.org \
--cc=airlied@gmail.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rodrigo.vivi@intel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).