Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ff9a082f authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media 

Pull media documentation updates from Mauro Carvalho Chehab:
 "This patch series does the conversion of all media documentation stuff
  to Restrutured Text markup format and add them to the
  Documentation/index.rst file.

  The media documentation was grouped into 4 books:

    - media uAPI
    - media kAPI
    - V4L driver-specific documentation
    - DVB driver-specific documentation

  It also contains several documentation improvements and one fixup
  patch for a core issue with cropcap.

  PS.  After this patch series, the media DocBook is deprecated and
  should be removed.  I'll add such patch on a future pull request"

* tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (322 commits)
  [media] cx23885-cardlist.rst: add a new card
  [media] doc-rst: add some needed escape codes
  [media] doc-rst: kapi: use :c:func: instead of :cpp:func
  doc-rst: kernel-doc: fix a change introduced by mistake
  [media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops
  [media] dvb_ringbuffer.h: some documentation improvements
  [media] v4l2-ctrls.h: fully document the header file
  [media] doc-rst: Fix some typedef ugly warnings
  [media] doc-rst: reorganize the kAPI v4l2 chapters
  [media] rename v4l2-framework.rst to v4l2-intro.rst
  [media] move V4L2 clocks to a separate .rst file
  [media] v4l2-fh.rst: add cross references and markups
  [media] v4l2-fh.rst: add fh contents from v4l2-framework.rst
  [media] v4l2-fh.h: add documentation for it
  [media] v4l2-event.rst: add cross-references and markups
  [media] v4l2-event.h: document all functions
  [media] v4l2-event.rst: add text from v4l2-framework.rst
  [media] v4l2-framework.rst: remove videobuf quick chapter
  [media] v4l2-dev: add cross-references and improve markup
  [media] doc-rst: move v4l2-dev doc to a separate file
  ...
parents 6a492b0f 85538b1a

Documentation/DocBook/device-drivers.tmpl

+0 −58
Original line number Diff line number Diff line
@@ -247,64 +247,6 @@ X!Isound/sound_firmware.c 
-->

  </chapter>



  <chapter id="mediadev">

     <title>Media Devices</title>



     <sect1><title>Video2Linux devices</title>

!Iinclude/media/tuner.h

!Iinclude/media/tuner-types.h

!Iinclude/media/tveeprom.h

!Iinclude/media/v4l2-async.h

!Iinclude/media/v4l2-ctrls.h

!Iinclude/media/v4l2-dv-timings.h

!Iinclude/media/v4l2-event.h

!Iinclude/media/v4l2-flash-led-class.h

!Iinclude/media/v4l2-mc.h

!Iinclude/media/v4l2-mediabus.h

!Iinclude/media/v4l2-mem2mem.h

!Iinclude/media/v4l2-of.h

!Iinclude/media/v4l2-rect.h

!Iinclude/media/v4l2-subdev.h

!Iinclude/media/videobuf2-core.h

!Iinclude/media/videobuf2-v4l2.h

!Iinclude/media/videobuf2-memops.h

     </sect1>

     <sect1><title>Digital TV (DVB) devices</title>

	<sect1><title>Digital TV Common functions</title>

!Idrivers/media/dvb-core/dvb_math.h

!Idrivers/media/dvb-core/dvb_ringbuffer.h

!Idrivers/media/dvb-core/dvbdev.h

	</sect1>

	<sect1><title>Digital TV Frontend kABI</title>

!Pdrivers/media/dvb-core/dvb_frontend.h Digital TV Frontend

!Idrivers/media/dvb-core/dvb_frontend.h

	</sect1>

	<sect1><title>Digital TV Demux kABI</title>

!Pdrivers/media/dvb-core/demux.h Digital TV Demux

	<sect1><title>Demux Callback API</title>

!Pdrivers/media/dvb-core/demux.h Demux Callback

	</sect1>

!Idrivers/media/dvb-core/demux.h

	</sect1>

	<sect1><title>Digital TV Conditional Access kABI</title>

!Idrivers/media/dvb-core/dvb_ca_en50221.h

	</sect1>

     </sect1>

    <sect1><title>Remote Controller devices</title>

!Iinclude/media/rc-core.h

!Iinclude/media/lirc_dev.h

    </sect1>

    <sect1><title>Media Controller devices</title>

!Pinclude/media/media-device.h Media Controller

!Iinclude/media/media-device.h

!Iinclude/media/media-devnode.h

!Iinclude/media/media-entity.h

    </sect1>

    <sect1><title>Consumer Electronics Control devices</title>

!Iinclude/media/cec-edid.h

    </sect1>



  </chapter>



  <chapter id="uart16x50">

     <title>16x50 UART Driver</title>

Documentation/DocBook/media/v4l/fdl-appendix.xml

+1 −1
Original line number Diff line number Diff line
@@ -526,7 +526,7 @@ 


    <para>

      You may extract a single document from such a collection, and

      dispbibute it individually under this License, provided you

      distribute it individually under this License, provided you

      insert a copy of this License into the extracted document, and

      follow this License in all other respects regarding verbatim

      copying of that document.

Documentation/DocBook/media/v4l/lirc_device_interface.xml

+1 −1
Original line number Diff line number Diff line
@@ -114,7 +114,7 @@ on working with the default settings initially.</para> 
      <para>Some receiver have maximum resolution which is defined by internal

      sample rate or data format limitations. E.g. it's common that signals can

      only be reported in 50 microsecond steps. This integer value is used by

      lircd to automatically adjust the aeps tolerance value in the lircd

      lircd to automatically adjust the steps tolerance value in the lircd

      config file.</para>

    </listitem>

  </varlistentry>

Documentation/Makefile.sphinx

+2 −1
Original line number Diff line number Diff line
@@ -38,9 +38,10 @@ ALLSPHINXOPTS = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(B 
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .



quiet_cmd_sphinx = SPHINX  $@

      cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2

      cmd_sphinx = BUILDDIR=$(BUILDDIR) $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2



htmldocs:

	$(MAKE) BUILDDIR=$(BUILDDIR) -f $(srctree)/Documentation/media/Makefile $@

	$(call cmd,sphinx,html)



pdfdocs:

Documentation/conf.py

+10 −3
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ sys.path.insert(0, os.path.abspath('sphinx')) 
# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = ['kernel-doc', 'rstFlatTable']

extensions = ['kernel-doc', 'rstFlatTable', 'kernel_include']



# Gracefully handle missing rst2pdf.

try:
@@ -176,7 +176,14 @@ except ImportError: 
# Add any paths that contain custom static files (such as style sheets) here,

# relative to this directory. They are copied after the builtin static files,

# so a file named "default.css" will overwrite the builtin "default.css".

#html_static_path = ['_static']



html_static_path = ['sphinx-static']



html_context = {

    'css_files': [

        '_static/theme_overrides.css',

    ],

}



# Add any extra paths that contain custom files (such as robots.txt or

# .htaccess) here, relative to this directory. These files are copied
@@ -404,7 +411,7 @@ epub_exclude_files = ['search.html'] 
# multiple PDF files here actually tries to get the cross-referencing right

# *between* PDF files.

pdf_documents = [

    ('index', u'Kernel', u'Kernel', u'J. Random Bozo'),

    ('kernel-documentation', u'Kernel', u'Kernel', u'J. Random Bozo'),

]



# kernel-doc extension configuration for running Sphinx directly (e.g. by Read