linux-pm.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Media <linux-media@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Block Devices <linux-block@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Power Management <linux-pm@vger.kernel.org>
Cc: Sakari Ailus <sakari.ailus@linux.intel.com>,
	Bingbu Cao <bingbu.cao@intel.com>,
	Tianshu Qiu <tian.shu.qiu@intel.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Ming Lei <ming.lei@redhat.com>, Jens Axboe <axboe@kernel.dk>,
	Jonathan Corbet <corbet@lwn.net>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Len Brown <len.brown@intel.com>, Pavel Machek <pavel@ucw.cz>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Rajmohan Mani <rajmohan.mani@intel.com>
Subject: [PATCH 1/3] media: ipu3.rst: Prune unreferenced footnotes
Date: Wed, 22 Jan 2025 21:34:54 +0700	[thread overview]
Message-ID: <20250122143456.68867-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250122143456.68867-1-bagasdotme@gmail.com>

Sphinx reports unreferenced footnotes warning on ipu3 docs:

Documentation/admin-guide/media/ipu3.rst:592: WARNING: Footnote [#] is not referenced. [ref.footnote]
Documentation/admin-guide/media/ipu3.rst:598: WARNING: Footnote [#] is not referenced. [ref.footnote]

Fix above warnings by pruning unreferenced footnote to intel_ipu3.h
UAPI header (already referenced in its full path in "Running mode and
firmware binary selection") and by directly link to v4l-utils repo in
ov5670 configuration example with media-ctl (since the example is in
literal code block).

Footnote numbers are unchanged.

Cc: Rajmohan Mani <rajmohan.mani@intel.com>
Fixes: dc794d3d2424 ("media: staging: ipu3-imgu: Move the UAPI header from include under include/uapi")
Fixes: 34fc0e1bf892 ("media: doc-rst: Add Intel IPU3 documentation")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/media/ipu3.rst | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/Documentation/admin-guide/media/ipu3.rst b/Documentation/admin-guide/media/ipu3.rst
index 83b3cd03b35c36..3a8c3d46304b7d 100644
--- a/Documentation/admin-guide/media/ipu3.rst
+++ b/Documentation/admin-guide/media/ipu3.rst
@@ -98,7 +98,8 @@ frames in packed raw Bayer format to IPU3 CSI2 receiver.
     # and that ov5670 sensor is connected to i2c bus 10 with address 0x36
     export SDEV=$(media-ctl -d $MDEV -e "ov5670 10-0036")
 
-    # Establish the link for the media devices using media-ctl [#f3]_
+    # Establish the link for the media devices using media-ctl
+    # (from https://git.linuxtv.org/v4l-utils.git)
     media-ctl -d $MDEV -l "ov5670:0 -> ipu3-csi2 0:0[1]"
 
     # Set the format for the media devices
@@ -589,12 +590,8 @@ preserved.
 References
 ==========
 
-.. [#f5] drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
-
 .. [#f1] https://github.com/intel/nvt
 
 .. [#f2] http://git.ideasonboard.org/yavta.git
 
-.. [#f3] http://git.ideasonboard.org/?p=media-ctl.git;a=summary
-
 .. [#f4] ImgU limitation requires an additional 16x16 for all input resolutions
-- 
An old man doll... just what I always wanted! - Clara


  reply	other threads:[~2025-01-22 14:35 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-22 14:34 [PATCH 0/3] Tree-wide nreferenced footnotes fixes Bagas Sanjaya
2025-01-22 14:34 ` Bagas Sanjaya [this message]
2025-01-23  3:55   ` [PATCH 1/3] media: ipu3.rst: Prune unreferenced footnotes Cao, Bingbu
2025-01-23  7:27   ` Sakari Ailus
2025-01-22 14:34 ` [PATCH 2/3] Documentation: ublk: Drop Stefan Hajnoczi's message footnote Bagas Sanjaya
2025-01-22 15:36   ` Stefan Hajnoczi
2025-01-22 14:34 ` [PATCH 3/3] docs: power: Fix footnote reference for Toshiba Satellite P10-554 Bagas Sanjaya
2025-01-22 17:26 ` [PATCH 0/3] Tree-wide nreferenced footnotes fixes Jonathan Corbet

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=20250122143456.68867-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=axboe@kernel.dk \
    --cc=bingbu.cao@intel.com \
    --cc=corbet@lwn.net \
    --cc=len.brown@intel.com \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=ming.lei@redhat.com \
    --cc=pavel@ucw.cz \
    --cc=rafael@kernel.org \
    --cc=rajmohan.mani@intel.com \
    --cc=sakari.ailus@linux.intel.com \
    --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;
as well as URLs for NNTP newsgroup(s).