Skip to content

Commit

Permalink
docs-rst: Don't use explicit Makefile rules to build SVG and DOT files
Browse files Browse the repository at this point in the history
Now that we have an extension to handle images, use it.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
mchehab authored and Jonathan Corbet committed Mar 13, 2017
1 parent db6ccf2 commit 8fa1bb5
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 91 deletions.
47 changes: 1 addition & 46 deletions Documentation/media/Makefile
Original file line number Diff line number Diff line change
@@ -1,51 +1,6 @@
# Rules to convert DOT and SVG to Sphinx images

SRC_DIR=$(srctree)/Documentation/media

DOTS = \
uapi/v4l/pipeline.dot \

IMAGES = \
typical_media_device.svg \
uapi/dvb/dvbstb.svg \
uapi/v4l/bayer.svg \
uapi/v4l/constraints.svg \
uapi/v4l/crop.svg \
uapi/v4l/fieldseq_bt.svg \
uapi/v4l/fieldseq_tb.svg \
uapi/v4l/nv12mt.svg \
uapi/v4l/nv12mt_example.svg \
uapi/v4l/pipeline.svg \
uapi/v4l/selection.svg \
uapi/v4l/subdev-image-processing-full.svg \
uapi/v4l/subdev-image-processing-scaling-multi-source.svg \
uapi/v4l/subdev-image-processing-crop.svg \
uapi/v4l/vbi_525.svg \
uapi/v4l/vbi_625.svg \
uapi/v4l/vbi_hsync.svg \

DOTTGT := $(patsubst %.dot,%.svg,$(DOTS))
IMGDOT := $(patsubst %,$(SRC_DIR)/%,$(DOTTGT))

IMGTGT := $(patsubst %.svg,%.pdf,$(IMAGES))
IMGPDF := $(patsubst %,$(SRC_DIR)/%,$(IMGTGT))

cmd = $(echo-cmd) $(cmd_$(1))

quiet_cmd_genpdf = GENPDF $2
cmd_genpdf = convert $2 $3

quiet_cmd_gendot = DOT $2
cmd_gendot = dot -Tsvg $2 > $3 || { rm -f $3; exit 1; }

%.pdf: %.svg
@$(call cmd,genpdf,$<,$@)

%.svg: %.dot
@$(call cmd,gendot,$<,$@)

# Rules to convert a .h file to inline RST documentation

SRC_DIR=$(srctree)/Documentation/media
PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
UAPI = $(srctree)/include/uapi/linux
KAPI = $(srctree)/include/linux
Expand Down
6 changes: 3 additions & 3 deletions Documentation/media/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ A typical media device hardware is shown at :ref:`typical_media_device`.

.. _typical_media_device:

.. figure:: typical_media_device.*
:alt: typical_media_device.pdf / typical_media_device.svg
:align: center
.. kernel-figure:: typical_media_device.svg
:alt: typical_media_device.svg
:align: center

Typical Media Device

Expand Down
6 changes: 3 additions & 3 deletions Documentation/media/uapi/dvb/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ Overview

.. _stb_components:

.. figure:: dvbstb.*
:alt: dvbstb.pdf / dvbstb.svg
:align: center
.. kernel-figure:: dvbstb.svg
:alt: dvbstb.svg
:align: center

Components of a DVB card/STB

Expand Down
4 changes: 2 additions & 2 deletions Documentation/media/uapi/v4l/crop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Cropping Structures

.. _crop-scale:

.. figure:: crop.*
:alt: crop.pdf / crop.svg
.. kernel-figure:: crop.svg
:alt: crop.svg
:align: center

Image Cropping, Insertion and Scaling
Expand Down
22 changes: 9 additions & 13 deletions Documentation/media/uapi/v4l/dev-raw-vbi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,33 +221,29 @@ and always returns default parameters as :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` does

.. _vbi-hsync:

.. figure:: vbi_hsync.*
:alt: vbi_hsync.pdf / vbi_hsync.svg
:align: center
.. kernel-figure:: vbi_hsync.svg
:alt: vbi_hsync.svg
:align: center

**Figure 4.1. Line synchronization**


.. _vbi-525:

.. figure:: vbi_525.*
:alt: vbi_525.pdf / vbi_525.svg
:align: center
.. kernel-figure:: vbi_525.svg
:alt: vbi_525.svg
:align: center

**Figure 4.2. ITU-R 525 line numbering (M/NTSC and M/PAL)**



.. _vbi-625:

.. figure:: vbi_625.*
:alt: vbi_625.pdf / vbi_625.svg
:align: center
.. kernel-figure:: vbi_625.svg
:alt: vbi_625.svg
:align: center

**Figure 4.3. ITU-R 625 line numbering**



Remember the VBI image format depends on the selected video standard,
therefore the application must choose a new standard or query the
current standard first. Attempts to read or write data ahead of format
Expand Down
22 changes: 11 additions & 11 deletions Documentation/media/uapi/v4l/dev-subdev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ the video sensor and the host image processing hardware.

.. _pipeline-scaling:

.. figure:: pipeline.*
:alt: pipeline.pdf / pipeline.svg
:align: center
.. kernel-figure:: pipeline.dot
:alt: pipeline.dot
:align: center

Image Format Negotiation on Pipelines

Expand Down Expand Up @@ -404,9 +404,9 @@ selection will refer to the sink pad format dimensions instead.

.. _subdev-image-processing-crop:

.. figure:: subdev-image-processing-crop.*
:alt: subdev-image-processing-crop.pdf / subdev-image-processing-crop.svg
:align: center
.. kernel-figure:: subdev-image-processing-crop.svg
:alt: subdev-image-processing-crop.svg
:align: center

**Figure 4.5. Image processing in subdevs: simple crop example**

Expand All @@ -421,9 +421,9 @@ pad.

.. _subdev-image-processing-scaling-multi-source:

.. figure:: subdev-image-processing-scaling-multi-source.*
:alt: subdev-image-processing-scaling-multi-source.pdf / subdev-image-processing-scaling-multi-source.svg
:align: center
.. kernel-figure:: subdev-image-processing-scaling-multi-source.svg
:alt: subdev-image-processing-scaling-multi-source.svg
:align: center

**Figure 4.6. Image processing in subdevs: scaling with multiple sources**

Expand All @@ -437,8 +437,8 @@ an area at location specified by the source crop rectangle from it.

.. _subdev-image-processing-full:

.. figure:: subdev-image-processing-full.*
:alt: subdev-image-processing-full.pdf / subdev-image-processing-full.svg
.. kernel-figure:: subdev-image-processing-full.svg
:alt: subdev-image-processing-full.svg
:align: center

**Figure 4.7. Image processing in subdevs: scaling and composition with multiple sinks and sources**
Expand Down
11 changes: 7 additions & 4 deletions Documentation/media/uapi/v4l/field-order.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,20 @@ enum v4l2_field
Field Order, Top Field First Transmitted
========================================

.. figure:: fieldseq_tb.*
:alt: fieldseq_tb.pdf / fieldseq_tb.svg
.. kernel-figure:: fieldseq_tb.svg
:alt: fieldseq_tb.svg
:align: center

Field Order, Top Field First Transmitted


.. _fieldseq-bt:

Field Order, Bottom Field First Transmitted
===========================================

.. figure:: fieldseq_bt.*
:alt: fieldseq_bt.pdf / fieldseq_bt.svg
.. kernel-figure:: fieldseq_bt.svg
:alt: fieldseq_bt.svg
:align: center

Field Order, Bottom Field First Transmitted
8 changes: 4 additions & 4 deletions Documentation/media/uapi/v4l/pixfmt-nv12mt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Layout of macroblocks in memory is presented in the following figure.

.. _nv12mt:

.. figure:: nv12mt.*
:alt: nv12mt.pdf / nv12mt.svg
.. kernel-figure:: nv12mt.svg
:alt: nv12mt.svg
:align: center

V4L2_PIX_FMT_NV12MT macroblock Z shape memory layout
Expand All @@ -50,8 +50,8 @@ interleaved. Height of the buffer is aligned to 32.

.. _nv12mt_ex:

.. figure:: nv12mt_example.*
:alt: nv12mt_example.pdf / nv12mt_example.svg
.. kernel-figure:: nv12mt_example.svg
:alt: nv12mt_example.svg
:align: center

Example V4L2_PIX_FMT_NV12MT memory layout of macroblocks
Expand Down
6 changes: 3 additions & 3 deletions Documentation/media/uapi/v4l/selection-api-003.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Selection targets

.. _sel-targets-capture:

.. figure:: selection.*
:alt: selection.pdf / selection.svg
:align: center
.. kernel-figure:: selection.svg
:alt: selection.svg
:align: center

Cropping and composing targets

Expand Down
4 changes: 2 additions & 2 deletions Documentation/media/uapi/v4l/subdev-formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1514,8 +1514,8 @@ be named ``MEDIA_BUS_FMT_SRGGB10_2X8_PADHI_LE``.

.. _bayer-patterns:

.. figure:: bayer.*
:alt: bayer.pdf / bayer.svg
.. kernel-figure:: bayer.svg
:alt: bayer.svg
:align: center

**Figure 4.8 Bayer Patterns**
Expand Down

0 comments on commit 8fa1bb5

Please sign in to comment.