1. 30 Sep, 2020 8 commits
    • Mauro Carvalho Chehab's avatar
      media: hist-v4l2.rst: remove struct duplication · f69249fc
      Mauro Carvalho Chehab authored
      There are several places there where struct was used twice,
      on multiple lines, like:
      
      	struct
      	struct ``v4l2_zoomcap``
      
      That's probably done during the DocBook to ReSt conversion.
      
      Probably the cases where "struct struct" were at the same line
      was addressed back then, but the multi-line cases are still
      there.
      
      Get rid of them.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      f69249fc
    • Mauro Carvalho Chehab's avatar
      media: v4l2-subdev.h: fix a kernel-doc markup · 8162a0b5
      Mauro Carvalho Chehab authored
      As reported by Sphinx:
      
      	./Documentation/driver-api/media/v4l2-subdev:490: ./include/media/v4l2-subdev.h:384: WARNING: Unparseable C cross-reference: 'struct'
      	Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
      	  struct
      	  ------^
      
      The markup there is wrong:
      	&struct &v4l2_input -> &struct v4l2_input
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      8162a0b5
    • Mauro Carvalho Chehab's avatar
      media: cec-core.rst: fix warnings with Sphinx 3.0+ · c3cfc5f4
      Mauro Carvalho Chehab authored
      The new C domain code on Sphinx 3 is a lot more pedantic.
      It only accepts real functions declared as c:function.
      
      So, declarations like this are not valid:
      
      	.. c:function::
      	        int (*adap_enable)(struct cec_adapter *adap, bool enable);
      
      Also, no blank lines are allowed after ".. c:function:", and
      continuation lines should be like:
      
      	.. c:function:
      		int (void foo, \
      		     int bar);
      
      Change the logic there, in order to avoid lots of warnings
      when built with Sphinx 3.x.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      c3cfc5f4
    • Mauro Carvalho Chehab's avatar
      media: v4l2-subdev.rst: get rid of a duplicatd kernel-doc markup · 181220d4
      Mauro Carvalho Chehab authored
      There are two kernel-doc markups for include/media/v4l2-async.h,
      one at v4l2-async.rst and another one at v4l2-subdev.rst.
      
      Sphinx 3.x checks it and complains for duplicated symbols.
      
      So, get rid of one of them.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      181220d4
    • Mauro Carvalho Chehab's avatar
      media: dvb-frontends: remove a clone of a kernel-doc markup at zd1301_demod.h · deacbb8e
      Mauro Carvalho Chehab authored
      The same markup are there twice, causing warnings with
      Sphinx 3.x. Drop the second copy.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      deacbb8e
    • Mauro Carvalho Chehab's avatar
      media: docs: ipu3.rst: rely at automarkup extension · b97d4a1e
      Mauro Carvalho Chehab authored
      There are several :c:type: definitions there, in order to
      do cross-references with the driver's documentation.
      
      Those are broken when docs are built with Sphinx 3.x, as
      it would require :c:struct: instead.
      
      For Sphinx < 3.x, the automarkup.py extension is able to do the
      replacement already, and a future improvement on it should make
      it also work with Sphinx 3.x.
      
      So, get rid of the usage of the :c:type: macro there.
      Reviewed-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      b97d4a1e
    • Mauro Carvalho Chehab's avatar
      media: glossary.rst: use the right case for glossary entries · 1c16b009
      Mauro Carvalho Chehab authored
      Sphinx 3.x is pedantic with glossary entries:
      
          Documentation/userspace-api/media/glossary.rst:17: WARNING: term device driver not found in case sensitive match.made a reference to Device Driver instead.
          Documentation/userspace-api/media/glossary.rst:59: WARNING: term media hardware not found in case sensitive match.made a reference to Media Hardware instead.
          Documentation/userspace-api/media/glossary.rst:59: WARNING: term IP block not found in case sensitive match.made a reference to IP Block instead.
          Documentation/userspace-api/media/glossary.rst:64: WARNING: term hardware component not found in case sensitive match.made a reference to Hardware Component instead.
          Documentation/userspace-api/media/glossary.rst:64: WARNING: term ip block not found in case sensitive match.made a reference to IP Block instead.
          Documentation/userspace-api/media/glossary.rst:70: WARNING: term peripheral not found in case sensitive match.made a reference to Peripheral instead.
          Documentation/userspace-api/media/glossary.rst:130: WARNING: term V4L2 hardware not found in case sensitive match.made a reference to V4L2 Hardware instead.
          Documentation/userspace-api/media/glossary.rst:151: WARNING: term hardware peripheral not found in case sensitive match.made a reference to Hardware Peripheral instead.
          Documentation/userspace-api/media/glossary.rst:183: WARNING: term device node not found in case sensitive match.made a reference to Device Node instead.
          Documentation/userspace-api/media/glossary.rst:191: WARNING: term bridge driver not found in case sensitive match.made a reference to Bridge Driver instead.
      
      While it works with case-insensitive entires, it complains.
      
      Let's fix it, in order to cleanup the warnings. Also, I won't
      doubt that a later change on Sphinx will end breaking support
      for it.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      1c16b009
    • Mauro Carvalho Chehab's avatar
      media: camera-sensor.rst: fix a doc build warning · 6fcadfc7
      Mauro Carvalho Chehab authored
      	Documentation/driver-api/media/camera-sensor.rst:123: WARNING: Inline literal start-string without end-string.
      
      There's a missing blank space over there.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
      6fcadfc7
  2. 27 Sep, 2020 32 commits