| Message ID | 20250122143456.68867-2-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Tree-wide nreferenced footnotes fixes | expand |
Reviewed-by: Bingbu Cao <bingbu.cao@intel.com> >-----Original Message----- >From: Bagas Sanjaya <bagasdotme@gmail.com> >Sent: Wednesday, January 22, 2025 10:35 PM >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>; Cao, Bingbu ><bingbu.cao@intel.com>; Qiu, Tian Shu <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>; Brown, Len <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 > >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
Hi Bagas, Thanks for the patches. On Wed, Jan 22, 2025 at 09:34:54PM +0700, Bagas Sanjaya wrote: > 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> The issues fixed by this patch have already been fixed in commit 688c0a6907a7c6e6776f314195c10536f249b37f (in media tree).
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
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(-)