Skip to content

Improve DVB frontend API documentation

Mauro Carvalho Chehab linux-api linux-media 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest34 of 35 patches 12 repliesIn review

34 of 35 patches are in this archive. The cover letter announces 35.

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/35DocBook: Update DVB supported standards at introductionDocumentation/DocBook/media_api.tmpl+3 -20 replies
2/35DocBook: add a note about the ALSA APIDocumentation/DocBook/media_api.tmpl+3 -01 reply
3/35DocBook: add drawing with a typical media deviceDocumentation/DocBook/media/Makefile Documentation/DocBook/media/typical_media_device.svg Documentation/DocBook/media_api.tmpl+39 -20 replies
4/35DocBook: fix emphasis at the DVB documentationDocumentation/DocBook/media/dvb/audio.xml Documentation/DocBook/media/dvb/ca.xml Documentation/DocBook/media/dvb/demux.xml +5 more+34 -343 replies
5/35DocBook: Improve DVB frontend descriptionDocumentation/DocBook/media/dvb/frontend.xml+28 -160 replies
6/35DocBook: move DVBv3 frontend bits to a separate sectionDocumentation/DocBook/media/dvb/frontend.xml Documentation/DocBook/media/dvb/frontend_legacy_api.xml+618 -5900 replies
7/35dvb: split enum from typedefs at frontend.hinclude/uapi/linux/dvb/frontend.h+8 -42 replies
8/35DocBook: reformat FE_GET_INFO ioctl documentationDocumentation/DocBook/media/dvb/frontend.xml+267 -1070 replies
9/35DocBook: move FE_GET_INFO to a separate xml fileDocumentation/DocBook/media/dvb/frontend.xml Documentation/DocBook/media/dvb/frontend_get_info.xml+266 -2650 replies
10/35DocBook: improve documentation for FE_READ_STATUSDocumentation/DocBook/media/dvb/frontend.xml Documentation/DocBook/media/dvb/frontend_read_status.xml+113 -1090 replies
11/35DocBook: move DVB properties to happen earlier at the documentDocumentation/DocBook/media/dvb/frontend.xml+2 -20 replies
12/35DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std wayDocumentation/DocBook/media/dvb/dvbproperty.xml+118 -960 replies
13/35DocBook: fix xref to the FE open() functionDocumentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/dvb/frontend_get_info.xml Documentation/DocBook/media/dvb/frontend_read_status.xml +1 more+5 -40 replies
14/35DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl descriptionDocumentation/DocBook/media/Makefile Documentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/dvb/frontend_legacy_api.xml+36 -720 replies
15/35DocBook: Improve the description of the properties APIDocumentation/DocBook/media/dvb/dvbproperty.xml+32 -51 reply
16/35DocBook: Add xref links for DTV propetiesDocumentation/DocBook/media/Makefile Documentation/DocBook/media/dvb/dvbproperty.xml+20 -60 replies
17/35DocBook: Improve xref check for undocumented ioctlsDocumentation/DocBook/media/Makefile+5 -30 replies
18/35DocBook: remove duplicated ioctl from v4l2-subdevDocumentation/DocBook/media/Makefile+0 -70 replies
19/35DocBook: Fix false positive undefined ioctl referencesDocumentation/DocBook/media/Makefile Documentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/v4l/vidioc-g-dv-timings.xml +3 more+13 -61 reply
20/35DocBook: Rename ioctl xml filesDocumentation/DocBook/media/dvb/fe-get-info.xml Documentation/DocBook/media/dvb/fe-read-status.xml Documentation/DocBook/media/dvb/frontend.xml+2 -20 replies
21/35DocBook: move FE_GET_PROPERTY to its own xml fileDocumentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/dvb/fe-get-property.xml+83 -820 replies
22/35DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctlDocumentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml Documentation/DocBook/media/dvb/frontend.xml+65 -310 replies
23/35DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctlDocumentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml Documentation/DocBook/media/dvb/frontend.xml+62 -490 replies
24/35DocBook: better document FE_SET_VOLTAGE ioctlDocumentation/DocBook/media/dvb/fe-set-voltage.xml Documentation/DocBook/media/dvb/frontend.xml include/uapi/linux/dvb/frontend.h+99 -630 replies
25/35DocBook: better document FE_SET_TONE ioctlDocumentation/DocBook/media/dvb/fe-set-tone.xml Documentation/DocBook/media/dvb/frontend.xml include/uapi/linux/dvb/frontend.h+93 -620 replies
27/35DocBook: better document FE_DISEQC_RECV_SLAVE_REPLYDocumentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml Documentation/DocBook/media/dvb/frontend.xml+79 -630 replies
28/35DocBook: better document FE_DISEQC_SEND_MASTER_CMDDocumentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml Documentation/DocBook/media/dvb/frontend.xml+73 -620 replies
29/35DocBook: better document FE_DISEQC_RESET_OVERLOADDocumentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml Documentation/DocBook/media/dvb/frontend.xml+52 -440 replies
30/35DocBook: better organize the function descriptions for frontendDocumentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/dvb/frontend.xml+3 -60 replies
31/35DocBook: fix FE_READ_STATUS argument descriptionDocumentation/DocBook/media/dvb/fe-read-status.xml+12 -80 replies
32/35DocBook: Provide a high-level description for DVB frontendDocumentation/DocBook/media/dvb/frontend.xml+16 -61 reply
33/35DocBook: add a proper description for dvb_frontend_info.fe_typeDocumentation/DocBook/media/dvb/frontend_legacy_api.xml+13 -30 replies
34/35DocBook: Better document enum fe_modulationDocumentation/DocBook/media/dvb/dvbproperty.xml Documentation/DocBook/media/dvb/frontend.xml include/uapi/linux/dvb/frontend.h+76 -470 replies
35/35DocBook: some fixes at FE_GET_INFODocumentation/DocBook/media/dvb/fe-get-info.xml+5 -40 replies

Reviews trailers per patch

1 of 34 patches has a Reviewed-by or Acked-by.

PatchHans Verkuil
1/35
2/35
3/35
4/35
5/35
6/35
7/35
8/35
9/35
10/35
11/35
12/35
13/35
14/35
15/35
16/35
17/35
18/35
19/35A-b
20/35
21/35
22/35
23/35
24/35
25/35
27/35
28/35
29/35
30/35
31/35
32/35
33/35
34/35
35/35

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 00/35] Improve DVB frontend API documentation

This is the first series of patches that will improve the DVB documentation.

Our DocBook was a conversion from a past LaTex documentation that had some parts updated to cover what's there at DVBv5 API and got merged with V4L2, media controller and remote controllers documentation to provide a consistent document about the media infrastructure API.

Yet, it doesn't follow the same format as other parts of the document.

This patch series rewrite lots of code inside the DVB frontend API documentation (with is the biggest chapter). It also moves the DVBv3 legacy stuff into a separate xml file, after the non-legacy stuff.

This should hopefully make clearer to the readers what's the recommended ioctls and what's deprecated.

This work is not complete yet: there are still some structures that are docummented on both frontend.xml and dvbproperty.xml, but, as we have already 35 patches, let me flush what I have so far.

Mauro Carvalho Chehab (35):
DocBook: Update DVB supported standards at introduction
DocBook: add a note about the ALSA API
DocBook: add drawing with a typical media device
DocBook: fix emphasis at the DVB documentation
DocBook: Improve DVB frontend description
DocBook: move DVBv3 frontend bits to a separate section
dvb: split enum from typedefs at frontend.h
DocBook: reformat FE_GET_INFO ioctl documentation
DocBook: move FE_GET_INFO to a separate xml file
DocBook: improve documentation for FE_READ_STATUS
DocBook: move DVB properties to happen earlier at the document
DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std way
DocBook: fix xref to the FE open() function
DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl description
DocBook: Improve the description of the properties API
DocBook: Add xref links for DTV propeties
DocBook: Improve xref check for undocumented ioctls
DocBook: remove duplicated ioctl from v4l2-subdev
DocBook: Fix false positive undefined ioctl references
DocBook: Rename ioctl xml files
DocBook: move FE_GET_PROPERTY to its own xml file
DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctl
DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctl
DocBook: better document FE_SET_VOLTAGE ioctl
DocBook: better document FE_SET_TONE ioctl
DocBook: better document FE_DISEQC_SEND_BURST ioctl
DocBook: better document FE_DISEQC_RECV_SLAVE_REPLY
DocBook: better document FE_DISEQC_SEND_MASTER_CMD
DocBook: better document FE_DISEQC_RESET_OVERLOAD
DocBook: better organize the function descriptions for frontend
DocBook: fix FE_READ_STATUS argument description
DocBook: Provide a high-level description for DVB frontend
DocBook: add a proper description for dvb_frontend_info.fe_type
DocBook: Better document enum fe_modulation
DocBook: some fixes at FE_GET_INFO

 Documentation/DocBook/media/Makefile               |   33 +-
 Documentation/DocBook/media/dvb/audio.xml          |    6 +-
 Documentation/DocBook/media/dvb/ca.xml             |    4 +-
 Documentation/DocBook/media/dvb/demux.xml          |   10 +-
 Documentation/DocBook/media/dvb/dvbproperty.xml    |  227 ++--
 .../media/dvb/fe-diseqc-recv-slave-reply.xml       |   78 ++
 .../DocBook/media/dvb/fe-diseqc-reset-overload.xml |   51 +
 .../DocBook/media/dvb/fe-diseqc-send-burst.xml     |   86 ++
 .../media/dvb/fe-diseqc-send-master-cmd.xml        |   72 ++
 .../media/dvb/fe-enable-high-lnb-voltage.xml       |   61 +
 Documentation/DocBook/media/dvb/fe-get-info.xml    |  266 ++++
 .../DocBook/media/dvb/fe-get-property.xml          |   81 ++
 Documentation/DocBook/media/dvb/fe-read-status.xml |  107 ++
 .../media/dvb/fe-set-frontend-tune-mode.xml        |   64 +
 Documentation/DocBook/media/dvb/fe-set-tone.xml    |   88 ++
 Documentation/DocBook/media/dvb/fe-set-voltage.xml |   94 ++
 Documentation/DocBook/media/dvb/frontend.xml       | 1351 +-------------------
 .../DocBook/media/dvb/frontend_legacy_api.xml      |  613 +++++++++
 Documentation/DocBook/media/dvb/intro.xml          |   26 +-
 Documentation/DocBook/media/dvb/kdapi.xml          |    4 +-
 Documentation/DocBook/media/dvb/net.xml            |    4 +-
 Documentation/DocBook/media/dvb/video.xml          |   10 +-
 .../DocBook/media/typical_media_device.svg         |   28 +
 .../DocBook/media/v4l/vidioc-g-dv-timings.xml      |    4 +-
 Documentation/DocBook/media/v4l/vidioc-g-edid.xml  |    4 +-
 .../DocBook/media/v4l/vidioc-query-dv-timings.xml  |    3 +-
 .../DocBook/media/v4l/vidioc-subscribe-event.xml   |    3 +-
 Documentation/DocBook/media_api.tmpl               |   25 +-
 include/uapi/linux/dvb/frontend.h                  |   36 +-
 29 files changed, 1974 insertions(+), 1465 deletions(-)
 create mode 100644 Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-diseqc-reset-overload.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-get-info.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-get-property.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-read-status.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-set-tone.xml
 create mode 100644 Documentation/DocBook/media/dvb/fe-set-voltage.xml
 create mode 100644 Documentation/DocBook/media/dvb/frontend_legacy_api.xml
 create mode 100644 Documentation/DocBook/media/typical_media_device.svg
Signature · 1 line
2.4.1