linux-kernel - [RFC v2 02/38] docs: media: ipu3: fix two footnote references

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <bed775ecc34a9261bdf672acd51073c4f2115550.1738020236.git.mchehab+huawei@kernel.org>
Date: Tue, 28 Jan 2025 01:05:51 +0100
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>,
	Jonathan Corbet <corbet@....net>,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
	"Mauro Carvalho Chehab" <mchehab+huawei@...nel.org>,
	Bingbu Cao <bingbu.cao@...el.com>,
	Sakari Ailus <sakari.ailus@...ux.intel.com>,
	Tianshu Qiu <tian.shu.qiu@...el.com>,
	linux-kernel@...r.kernel.org,
	linux-media@...r.kernel.org
Subject: [RFC v2 02/38] docs: media: ipu3: fix two footnote references

Sphinx doesn't process references inside a code block. They need
to be before that.

Also, one of the refrences is missing a footnote origin. Add it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
---
 Documentation/admin-guide/media/ipu3.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/admin-guide/media/ipu3.rst b/Documentation/admin-guide/media/ipu3.rst
index 83b3cd03b35c..b0d42cea5391 100644
--- a/Documentation/admin-guide/media/ipu3.rst
+++ b/Documentation/admin-guide/media/ipu3.rst
@@ -87,8 +87,8 @@ raw Bayer format that is specific to IPU3.
 Let us take the example of ov5670 sensor connected to CSI2 port 0, for a
 2592x1944 image capture.
 
-Using the media controller APIs, the ov5670 sensor is configured to send
-frames in packed raw Bayer format to IPU3 CSI2 receiver.
+Using the media controller APIs\ [#f3]_, the ov5670 sensor is configured to
+send frames in packed raw Bayer format to IPU3 CSI2 receiver.
 
 .. code-block:: none
 
@@ -98,7 +98,7 @@ 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
     media-ctl -d $MDEV -l "ov5670:0 -> ipu3-csi2 0:0[1]"
 
     # Set the format for the media devices
@@ -248,9 +248,9 @@ hence "STILL" mode will need more power and memory bandwidth than "VIDEO" mode.
 TNR will be enabled in "VIDEO" mode and bypassed by "STILL" mode. ImgU is
 running at "VIDEO" mode by default, the user can use v4l2 control
 V4L2_CID_INTEL_IPU3_MODE (currently defined in
-drivers/staging/media/ipu3/include/uapi/intel-ipu3.h) to query and set the
-running mode. For user, there is no difference for buffer queueing between the
-"VIDEO" and "STILL" mode, mandatory input and main output node should be
+drivers/staging/media/ipu3/include/uapi/intel-ipu3.h\ [#f5]_) to query and set
+the running mode. For user, there is no difference for buffer queueing between
+the "VIDEO" and "STILL" mode, mandatory input and main output node should be
 enabled and buffers need be queued, the statistics and the view-finder queues
 are optional.
 
-- 
2.48.1