Skip to content

Fix PDF builds on media documentation

Mauro Carvalho Chehab lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v2 Latest6 patches 4 repliesIn review

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6docs-rst: fix LaTeX \DURole renewcommand with Sphinx 1.3+Documentation/conf.py Documentation/media/index.rst+5 -60 replies
2/6subdev-formats.rst: don't use adjustbox on a longtableDocumentation/media/uapi/v4l/subdev-formats.rst+9 -20 replies
3/6subdev-formats.rst: add missing columns to tabularcolumnsDocumentation/media/uapi/v4l/subdev-formats.rst+1 -10 replies
4/6convert some images from png to svgDocumentation/media/uapi/dvb/intro.rst Documentation/media/uapi/dvb/intro_files/dvbstb.png Documentation/media/uapi/dvb/intro_files/dvbstb.svg +3 more+539 -20 replies
5/6docs-rst: convert gif files to pngDocumentation/media/uapi/v4l/crop_files/crop.gif Documentation/media/uapi/v4l/crop_files/crop.png Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_525.gif +9 more+0 -00 replies
6/6docs-rst: auto-generate PDF image filesDocumentation/Makefile.sphinx Documentation/media/Makefile Documentation/media/intro.rst +38 more+75 -360 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.

Read the v2 thread

Cover letter [PATCH v2 0/6] Fix PDF builds on media documentation

This series address a series of errors during PDF generation from media documentation.

It replaces the previous patch series entitled:
[PATCH RFC 0/4] Fix PDF build errors

The first patch fixes the late redefinition of a LaTeX command at the Sphinx LaTeX style that causes build to break when some cross-references are used.

The next two patches fix PDF output issues with subdev-formats.rst.

The next 3 patches fix image includes and their output for PDF.

It is aligned with Linus request of not having binary-generated images from their PNG or SVG source codes.

I still intend to move the remaing PNG images to vectorial ones (SVG), as image scale works better, but this will require some additional work. When done, I'll submit as a separate patch series.

It should also be noticed that the last patch violates the output dir, when make is used with "O=some_dir", as Sphinx doesn't accept image files outside the source directory. We'll likely need some Sphinx extension in order to fix it, but at least with this series (plus Jani Nikola's PDF fix series), the PDF output should work fine again.

Mauro Carvalho Chehab (6):
docs-rst: fix LaTeX \DURole renewcommand with Sphinx 1.3+ [media] subdev-formats.rst: don't use adjustbox on a longtable [media] subdev-formats.rst: add missing columns to tabularcolumns [media] convert some images from png to svg
[media] docs-rst: convert gif files to png
[media] docs-rst: auto-generate PDF image files

 Documentation/Makefile.sphinx                      |   3 +-
 Documentation/conf.py                              |   6 +-
 Documentation/media/Makefile                       |  42 ++-
 Documentation/media/index.rst                      |   5 -
 Documentation/media/intro.rst                      |   4 +-
 .../media/media_api_files/typical_media_device.pdf | Bin 52895 -> 0 bytes
 .../{media_api_files => }/typical_media_device.svg |   0
 Documentation/media/uapi/dvb/dvbstb.svg            | 318 +++++++++++++++++++++
 Documentation/media/uapi/dvb/intro.rst             |   4 +-
 .../media/uapi/dvb/intro_files/dvbstb.pdf          | Bin 1881 -> 0 bytes
 .../media/uapi/dvb/intro_files/dvbstb.png          | Bin 22655 -> 0 bytes
 .../uapi/v4l/{subdev-formats_files => }/bayer.png  | Bin
 Documentation/media/uapi/v4l/constraints.svg       | 219 ++++++++++++++
 Documentation/media/uapi/v4l/crop.png              | Bin 0 -> 3334 bytes
 Documentation/media/uapi/v4l/crop.rst              |   4 +-
 Documentation/media/uapi/v4l/crop_files/crop.gif   | Bin 5967 -> 0 bytes
 Documentation/media/uapi/v4l/crop_files/crop.pdf   | Bin 5846 -> 0 bytes
 Documentation/media/uapi/v4l/dev-raw-vbi.rst       |  12 +-
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_525.gif   | Bin 4741 -> 0 bytes
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_525.pdf   | Bin 3706 -> 0 bytes
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_625.gif   | Bin 5095 -> 0 bytes
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf   | Bin 3996 -> 0 bytes
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_hsync.gif | Bin 2400 -> 0 bytes
 .../media/uapi/v4l/dev-raw-vbi_files/vbi_hsync.pdf | Bin 7405 -> 0 bytes
 Documentation/media/uapi/v4l/dev-subdev.rst        |  14 +-
 .../media/uapi/v4l/dev-subdev_files/pipeline.pdf   | Bin 20276 -> 0 bytes
 .../subdev-image-processing-crop.pdf               | Bin 20729 -> 0 bytes
 .../subdev-image-processing-full.pdf               | Bin 46311 -> 0 bytes
 ...ubdev-image-processing-scaling-multi-source.pdf | Bin 36714 -> 0 bytes
 Documentation/media/uapi/v4l/field-order.rst       |   8 +-
 .../uapi/v4l/field-order_files/fieldseq_bt.gif     | Bin 25430 -> 0 bytes
 .../uapi/v4l/field-order_files/fieldseq_bt.pdf     | Bin 9185 -> 0 bytes
 .../uapi/v4l/field-order_files/fieldseq_tb.gif     | Bin 25323 -> 0 bytes
 .../uapi/v4l/field-order_files/fieldseq_tb.pdf     | Bin 9173 -> 0 bytes
 Documentation/media/uapi/v4l/fieldseq_bt.png       | Bin 0 -> 12306 bytes
 Documentation/media/uapi/v4l/fieldseq_tb.png       | Bin 0 -> 12247 bytes
 .../uapi/v4l/{pixfmt-nv12mt_files => }/nv12mt.png  | Bin
 .../{pixfmt-nv12mt_files => }/nv12mt_example.png   | Bin
 .../uapi/v4l/{dev-subdev_files => }/pipeline.png   | Bin
 Documentation/media/uapi/v4l/pixfmt-nv12mt.rst     |   8 +-
 Documentation/media/uapi/v4l/selection-api-003.rst |   4 +-
 .../{selection-api-003_files => }/selection.png    | Bin
 Documentation/media/uapi/v4l/subdev-formats.rst    |  19 +-
 .../subdev-image-processing-crop.svg               |   0
 .../subdev-image-processing-full.svg               |   0
 ...ubdev-image-processing-scaling-multi-source.svg |   0
 Documentation/media/uapi/v4l/vbi_525.png           | Bin 0 -> 2053 bytes
 Documentation/media/uapi/v4l/vbi_625.png           | Bin 0 -> 2352 bytes
 Documentation/media/uapi/v4l/vbi_hsync.png         | Bin 0 -> 906 bytes
 .../media/uapi/v4l/vidioc-g-selection.rst          |   4 +-
 .../v4l/vidioc-g-selection_files/constraints.png   | Bin 3313 -> 0 bytes
 51 files changed, 628 insertions(+), 46 deletions(-)
 delete mode 100644 Documentation/media/media_api_files/typical_media_device.pdf
 rename Documentation/media/{media_api_files => }/typical_media_device.svg (100%)
 create mode 100644 Documentation/media/uapi/dvb/dvbstb.svg
 delete mode 100644 Documentation/media/uapi/dvb/intro_files/dvbstb.pdf
 delete mode 100644 Documentation/media/uapi/dvb/intro_files/dvbstb.png
 rename Documentation/media/uapi/v4l/{subdev-formats_files => }/bayer.png (100%)
 create mode 100644 Documentation/media/uapi/v4l/constraints.svg
 create mode 100644 Documentation/media/uapi/v4l/crop.png
 delete mode 100644 Documentation/media/uapi/v4l/crop_files/crop.gif
 delete mode 100644 Documentation/media/uapi/v4l/crop_files/crop.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_525.gif
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_525.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.gif
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_625.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_hsync.gif
 delete mode 100644 Documentation/media/uapi/v4l/dev-raw-vbi_files/vbi_hsync.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-subdev_files/pipeline.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-subdev_files/subdev-image-processing-crop.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-subdev_files/subdev-image-processing-full.pdf
 delete mode 100644 Documentation/media/uapi/v4l/dev-subdev_files/subdev-image-processing-scaling-multi-source.pdf
 delete mode 100644 Documentation/media/uapi/v4l/field-order_files/fieldseq_bt.gif
 delete mode 100644 Documentation/media/uapi/v4l/field-order_files/fieldseq_bt.pdf
 delete mode 100644 Documentation/media/uapi/v4l/field-order_files/fieldseq_tb.gif
 delete mode 100644 Documentation/media/uapi/v4l/field-order_files/fieldseq_tb.pdf
 create mode 100644 Documentation/media/uapi/v4l/fieldseq_bt.png
 create mode 100644 Documentation/media/uapi/v4l/fieldseq_tb.png
 rename Documentation/media/uapi/v4l/{pixfmt-nv12mt_files => }/nv12mt.png (100%)
 rename Documentation/media/uapi/v4l/{pixfmt-nv12mt_files => }/nv12mt_example.png (100%)
 rename Documentation/media/uapi/v4l/{dev-subdev_files => }/pipeline.png (100%)
 rename Documentation/media/uapi/v4l/{selection-api-003_files => }/selection.png (100%)
 rename Documentation/media/uapi/v4l/{dev-subdev_files => }/subdev-image-processing-crop.svg (100%)
 rename Documentation/media/uapi/v4l/{dev-subdev_files => }/subdev-image-processing-full.svg (100%)
 rename Documentation/media/uapi/v4l/{dev-subdev_files => }/subdev-image-processing-scaling-multi-source.svg (100%)
 create mode 100644 Documentation/media/uapi/v4l/vbi_525.png
 create mode 100644 Documentation/media/uapi/v4l/vbi_625.png
 create mode 100644 Documentation/media/uapi/v4l/vbi_hsync.png
 delete mode 100644 Documentation/media/uapi/v4l/vidioc-g-selection_files/constraints.png
Signature · 1 line
2.7.4