From: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
To: sakari.ailus@linux.intel.com, bingbu.cao@intel.com,
tian.shu.qiu@intel.com
Cc: Kohshi Yamaguchi <kohshi54.yam@gmail.com>,
mchehab@kernel.org, gregkh@linuxfoundation.org,
linux-media@vger.kernel.org, linux-staging@lists.linux.dev,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org
Subject: [PATCH] doc: ipu3: Fix UAPI header doc warnings
Date: Mon, 29 Jan 2024 07:52:58 +0900 [thread overview]
Message-ID: <20240128225258.50375-1-kohshi54.yam@gmail.com> (raw)
The ipu3_uapi_acc_param struct in the IPU3 UAPI header mentioned
reserved1 and reserved2 fields, which are absent in the actual
structure definition. This mismatch led to Sphinx build warnings
due to inconsistencies between the documentation and the code.
This patch removes these non-existent reserved field references
from the documentation, resolving the Sphinx build warnings and
ensuring the UAPI header is accurately documented.
Signed-off-by: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
---
drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 2 --
1 file changed, 2 deletions(-)
diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
index caa358e0bae4..926fcf84e33c 100644
--- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
+++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
@@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
* &ipu3_uapi_yuvp1_y_ee_nr_config
* @yds: y down scaler config. See &ipu3_uapi_yuvp1_yds_config
* @chnr: chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
- * @reserved1: reserved
* @yds2: y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
* @tcc: total color correction config as defined in struct
* &ipu3_uapi_yuvp2_tcc_static_config
- * @reserved2: reserved
* @anr: advanced noise reduction config.See &ipu3_uapi_anr_config
* @awb_fr: AWB filter response config. See ipu3_uapi_awb_fr_config
* @ae: auto exposure config As specified by &ipu3_uapi_ae_config
--
2.34.1
next reply other threads:[~2024-01-28 22:53 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-28 22:52 Kohshi Yamaguchi [this message]
2024-01-28 23:21 ` Randy Dunlap
2024-01-29 7:29 ` Kohshi Yamaguchi
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=20240128225258.50375-1-kohshi54.yam@gmail.com \
--to=kohshi54.yam@gmail.com \
--cc=bingbu.cao@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=mchehab@kernel.org \
--cc=sakari.ailus@linux.intel.com \
--cc=skhan@linuxfoundation.org \
--cc=tian.shu.qiu@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
all inboxes | Powered by JetHome®