All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@intel.com>
To: intel-gfx@lists.freedesktop.org
Cc: jani.nikula@intel.com
Subject: [Intel-gfx] [PATCH 17/24] drm/i915/guc: drop lots of kernel-doc markers
Date: Tue,  2 May 2023 18:37:34 +0300	[thread overview]
Message-ID: <9c210d53fdbd6da5fac42e435855d269504919d7.1683041799.git.jani.nikula@intel.com> (raw)
In-Reply-To: <cover.1683041799.git.jani.nikula@intel.com>

The documentation is closer to not being kernel-doc, so just drop the
kernel-doc markers.

drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:27: warning: Function parameter or member 'size' not described in '__guc_capture_bufstate'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:27: warning: Function parameter or member 'data' not described in '__guc_capture_bufstate'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:27: warning: Function parameter or member 'rd' not described in '__guc_capture_bufstate'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:27: warning: Function parameter or member 'wr' not described in '__guc_capture_bufstate'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'link' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'is_partial' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'eng_class' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'eng_inst' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'guc_id' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'lrca' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:59: warning: Function parameter or member 'reginfo' not described in '__guc_capture_parsed_output'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:62: warning: wrong kernel-doc identifier on line:
 * struct guc_debug_capture_list_header / struct guc_debug_capture_list
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:80: warning: wrong kernel-doc identifier on line:
 * struct __guc_mmio_reg_descr / struct __guc_mmio_reg_descr_group
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:105: warning: wrong kernel-doc identifier on line:
 * struct guc_state_capture_header_t / struct guc_state_capture_t /
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:163: warning: Function parameter or member 'is_valid' not described in '__guc_capture_ads_cache'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:163: warning: Function parameter or member 'ptr' not described in '__guc_capture_ads_cache'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:163: warning: Function parameter or member 'size' not described in '__guc_capture_ads_cache'
drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h:163: warning: Function parameter or member 'status' not described in '__guc_capture_ads_cache'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'marker' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'read_ptr' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'write_ptr' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'size' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'sampled_write_ptr' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'wrap_offset' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'flush_to_file' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'buffer_full_cnt' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'reserved' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'flags' not described in 'guc_log_buffer_state'
drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h:491: warning: Function parameter or member 'version' not described in 'guc_log_buffer_state'

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h | 12 ++++++------
 drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h   |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h b/drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h
index 9d589c28f40f..1b6c219e1675 100644
--- a/drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h
+++ b/drivers/gpu/drm/i915/gt/uc/guc_capture_fwif.h
@@ -12,7 +12,7 @@
 struct intel_guc;
 struct file;
 
-/**
+/*
  * struct __guc_capture_bufstate
  *
  * Book-keeping structure used to track read and write pointers
@@ -26,7 +26,7 @@ struct __guc_capture_bufstate {
 	u32 wr;
 };
 
-/**
+/*
  * struct __guc_capture_parsed_output - extracted error capture node
  *
  * A single unit of extracted error-capture output data grouped together
@@ -58,7 +58,7 @@ struct __guc_capture_parsed_output {
 #define GCAP_PARSED_REGLIST_INDEX_ENGINST  BIT(GUC_CAPTURE_LIST_TYPE_ENGINE_INSTANCE)
 };
 
-/**
+/*
  * struct guc_debug_capture_list_header / struct guc_debug_capture_list
  *
  * As part of ADS registration, these header structures (followed by
@@ -76,7 +76,7 @@ struct guc_debug_capture_list {
 	struct guc_mmio_reg regs[];
 } __packed;
 
-/**
+/*
  * struct __guc_mmio_reg_descr / struct __guc_mmio_reg_descr_group
  *
  * intel_guc_capture module uses these structures to maintain static
@@ -101,7 +101,7 @@ struct __guc_mmio_reg_descr_group {
 	struct __guc_mmio_reg_descr *extlist; /* only used for steered registers */
 };
 
-/**
+/*
  * struct guc_state_capture_header_t / struct guc_state_capture_t /
  * guc_state_capture_group_header_t / guc_state_capture_group_t
  *
@@ -148,7 +148,7 @@ struct guc_state_capture_group_t {
 	struct guc_state_capture_t capture_entries[];
 } __packed;
 
-/**
+/*
  * struct __guc_capture_ads_cache
  *
  * A structure to cache register lists that were populated and registered
diff --git a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h
index 4ae5fc2f6002..8bb9ed7c7b4d 100644
--- a/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h
+++ b/drivers/gpu/drm/i915/gt/uc/intel_guc_fwif.h
@@ -451,7 +451,7 @@ enum guc_log_buffer_type {
 	GUC_MAX_LOG_BUFFER
 };
 
-/**
+/*
  * struct guc_log_buffer_state - GuC log buffer state
  *
  * Below state structure is used for coordination of retrieval of GuC firmware
-- 
2.39.2


  parent reply	other threads:[~2023-05-02 15:39 UTC|newest]

Thread overview: 63+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-02 15:37 [Intel-gfx] [PATCH 00/24] drm/i915: fix kernel-doc warnings, enable kernel-doc -Werror Jani Nikula
2023-05-02 15:37 ` [Intel-gfx] [PATCH 01/24] drm/i915/gvt: fix intel_vgpu_alloc_resource() kernel-doc parameter Jani Nikula
2023-05-03 14:07   ` Rodrigo Vivi
2023-05-04  9:15     ` Jani Nikula
2023-05-02 15:37 ` [Intel-gfx] [PATCH 02/24] drm/i915/vma: fix kernel-doc function name for i915_vma_size() Jani Nikula
2023-05-03 14:08   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 03/24] drm/i915/utils: drop kernel-doc from __wait_for() Jani Nikula
2023-05-03 14:09   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 04/24] drm/i915/vma: document struct i915_vma_resource wakeref member Jani Nikula
2023-05-03 14:16   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 05/24] drm/i915/vma: fix struct i915_vma_bindinfo kernel-doc Jani Nikula
2023-05-03 14:13   ` Rodrigo Vivi
2023-05-04  9:43     ` Jani Nikula
2023-05-04 14:54       ` Rodrigo Vivi
2023-05-04 21:51         ` Jani Nikula
2023-05-05 10:30         ` Jani Nikula
2023-05-02 15:37 ` [Intel-gfx] [PATCH 06/24] drm/i915/perf: fix i915_perf_ioctl_version() kernel-doc Jani Nikula
2023-05-03 14:14   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 07/24] drm/i915/error: fix i915_capture_error_state() kernel-doc Jani Nikula
2023-05-03 14:15   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 08/24] drm/i915/request: drop kernel-doc Jani Nikula
2023-05-03 14:19   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 09/24] drm/i915/gem: fix i915_gem_object_lookup_rcu() kernel-doc parameter name Jani Nikula
2023-05-03 14:20   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 10/24] drm/i915/gem: fix function pointer member kernel-doc Jani Nikula
2023-05-03 14:24   ` Rodrigo Vivi
2023-05-04  9:20     ` Jani Nikula
2023-05-04 14:55       ` Rodrigo Vivi
2023-05-04 21:53         ` Jani Nikula
2023-05-05 10:30         ` Jani Nikula
2023-05-02 15:37 ` [Intel-gfx] [PATCH 11/24] drm/i915/ttm: fix i915_ttm_to_gem() kernel-doc Jani Nikula
2023-05-03 14:27   ` Rodrigo Vivi
2023-05-04  9:24     ` Jani Nikula
2023-05-02 15:37 ` [Intel-gfx] [PATCH 12/24] drm/i915/engine: fix kernel-doc function name for intel_engine_cleanup_common() Jani Nikula
2023-05-03 14:28   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 13/24] drm/i915/context: fix kernel-doc parameter descriptions Jani Nikula
2023-05-03 14:29   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 14/24] drm/i915/gtt: fix i915_vm_resv_put() kernel-doc parameter name Jani Nikula
2023-05-03 14:29   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 15/24] drm/i915/engine: hide preempt_hang selftest member from kernel-doc Jani Nikula
2023-05-03 14:34   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 16/24] drm/i915/guc: add dbgfs_node member kernel-doc Jani Nikula
2023-05-03 14:34   ` Rodrigo Vivi
2023-05-02 15:37 ` Jani Nikula [this message]
2023-05-03 14:37   ` [Intel-gfx] [PATCH 17/24] drm/i915/guc: drop lots of kernel-doc markers Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 18/24] drm/i915/guc: add intel_guc_state_capture member docs for ads_null_cache and max_mmio_per_node Jani Nikula
2023-05-03 14:38   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 19/24] drm/i915/active: fix kernel-doc for function parameters Jani Nikula
2023-05-03 14:38   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 20/24] drm/i915/pmu: drop kernel-doc Jani Nikula
2023-05-03 14:39   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 21/24] drm/i915/pxp: fix kernel-doc for member dev_link Jani Nikula
2023-05-03 14:40   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 22/24] drm/i915/scatterlist: fix kernel-doc Jani Nikula
2023-05-04 14:56   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 23/24] drm/i915/scatterlist: fix kernel-doc parameter documentation Jani Nikula
2023-05-03 14:40   ` Rodrigo Vivi
2023-05-02 15:37 ` [Intel-gfx] [PATCH 24/24] drm/i915: use kernel-doc -Werror when CONFIG_DRM_I915_WERROR=y Jani Nikula
2023-05-03 14:41   ` Rodrigo Vivi
2023-05-02 16:39 ` [Intel-gfx] ✗ Fi.CI.SPARSE: warning for drm/i915: fix kernel-doc warnings, enable kernel-doc -Werror Patchwork
2023-05-02 16:49 ` [Intel-gfx] ✓ Fi.CI.BAT: success " Patchwork
2023-05-02 18:37 ` [Intel-gfx] ✗ Fi.CI.IGT: failure " Patchwork
2023-05-04 18:19 ` [Intel-gfx] ✗ Fi.CI.BUILD: failure for drm/i915: fix kernel-doc warnings, enable kernel-doc -Werror (rev2) 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=9c210d53fdbd6da5fac42e435855d269504919d7.1683041799.git.jani.nikula@intel.com \
    --to=jani.nikula@intel.com \
    --cc=intel-gfx@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 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.