linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Subject: [PATCH v2 00/37] DVB cleanups and documentation improvements
Date: Wed, 27 Sep 2017 18:40:01 -0300	[thread overview]
Message-ID: <cover.1506547906.git.mchehab@s-opensource.com> (raw)

This patch series merges a 6 patches series I sent earlier, and a 25 patch
series.

It comes after the patch series with add support for nexted structs/enums
on kernel-doc.

I"m pushing it on my experimental tree:

    https://git.linuxtv.org/mchehab/experimental.git/log/?h=dvb-fixes-v5

It is mainly focused on improving the DVB kAPI documentation, making
it (finally!) in sync with the current implementation. It also contains
a patch getting rid of the legacy (non-working) uAPI examples.

While reviewing the code implementation, I noticed some struct fields
that aren't used at all by any DVB driver or core. So, the series gets
rid of them. Others are used only on av7110, and are documented as
such.

After this patch series, both DVB uAPI and kAPI are fully documented
(except for the legacy video/audio/osd uAPI, that doesn't have any
kAPI associated to them).

Granted, some things could be improved at the documentation, but at
least it doesn't carry anymore any big gap or conflict!

Please review and test.

---

v2:

  - merged with a previous 6 patch series;
  - added patches at the end adding support for nexted structs/enums.


Mauro Carvalho Chehab (36):
  media: dvb_frontend: only use kref after initialized
  media: stv0288: get rid of set_property boilerplate
  media: stv6110: get rid of a srate dead code
  media: friio-fe: get rid of set_property()
  media: dvb_frontend: get rid of get_property() callback
  media: dvb_frontend: get rid of set_property() callback
  media: dvb_frontend: cleanup dvb_frontend_ioctl_properties()
  media: dvb_frontend: cleanup ioctl handling logic
  media: dvb_frontend: get rid of property cache's state
  media: dvb_frontend.h: fix alignment at the cache properties
  media: dvb_frontend: better document the -EPERM condition
  media: dvb_frontend: fix return values for FE_SET_PROPERTY
  media: dvbdev: convert DVB device types into an enum
  media: dvbdev: fully document its functions
  media: dvb_frontend.h: improve kernel-doc markups
  media: dtv-core.rst: add chapters and introductory tests for common
    parts
  media: dtv-core.rst: split into multiple files
  media: dtv-demux.rst: minor markup improvements
  media: dvb_demux.h: add an enum for DMX_TYPE_* and document
  media: dvb_demux.h: add an enum for DMX_STATE_* and document
  media: dvb_demux.h: get rid of unused timer at struct dvb_demux_filter
  media: dvb_demux: mark a boolean field as such
  media: dvb_demux: dvb_demux_feed.pusi_seen is boolean
  media: dvb_demux.h: get rid of DMX_FEED_ENTRY() macro
  media: dvb_demux: fix type of dvb_demux_feed.ts_type
  media: dvb_demux: document dvb_demux_filter and dvb_demux_feed
  media: dvb_frontend: get rid of dtv_get_property_dump()
  media: dvb_demux.h: document structs defined on it
  media: dvb_demux.h: document functions
  media: dmxdev.h: add kernel-doc markups for data types and functions
  media: dtv-demux.rst: parse other demux headers with kernel-doc
  media: dvb-net.rst: document DVB network kAPI interface
  media: dvb uAPI docs: get rid of examples section
  media: dmxdev: use the newly nested kernel-doc support
  media: dvb_demux: use the newly nested kernel-doc support
  media: frontend: use the newly nested kernel-doc support

Satendra Singh Thakur (1):
  media: dvb_frontend: dtv_property_process_set() cleanups

 Documentation/media/kapi/dtv-ca.rst              |   4 +
 Documentation/media/kapi/dtv-common.rst          |  55 +++
 Documentation/media/kapi/dtv-core.rst            | 574 +----------------------
 Documentation/media/kapi/dtv-demux.rst           |  82 ++++
 Documentation/media/kapi/dtv-frontend.rst        | 443 +++++++++++++++++
 Documentation/media/kapi/dtv-net.rst             |   4 +
 Documentation/media/uapi/dvb/examples.rst        | 378 +--------------
 Documentation/media/uapi/dvb/fe-get-property.rst |   7 +-
 Documentation/media/uapi/dvb/net-types.rst       |   2 +-
 drivers/media/dvb-core/dmxdev.h                  |  95 +++-
 drivers/media/dvb-core/dvb_demux.c               |  17 +-
 drivers/media/dvb-core/dvb_demux.h               | 253 +++++++++-
 drivers/media/dvb-core/dvb_frontend.c            | 534 +++++++++++----------
 drivers/media/dvb-core/dvb_frontend.h            | 117 ++---
 drivers/media/dvb-core/dvb_net.h                 |  34 +-
 drivers/media/dvb-core/dvbdev.c                  |  34 +-
 drivers/media/dvb-core/dvbdev.h                  | 137 +++++-
 drivers/media/dvb-frontends/lg2160.c             |  14 -
 drivers/media/dvb-frontends/stv0288.c            |   7 -
 drivers/media/dvb-frontends/stv6110.c            |   9 -
 drivers/media/pci/ttpci/av7110.c                 |   2 +-
 drivers/media/pci/ttpci/budget-core.c            |   2 +-
 drivers/media/usb/dvb-usb/friio-fe.c             |  24 -
 include/uapi/linux/dvb/frontend.h                |  35 +-
 24 files changed, 1457 insertions(+), 1406 deletions(-)
 create mode 100644 Documentation/media/kapi/dtv-ca.rst
 create mode 100644 Documentation/media/kapi/dtv-common.rst
 create mode 100644 Documentation/media/kapi/dtv-demux.rst
 create mode 100644 Documentation/media/kapi/dtv-frontend.rst
 create mode 100644 Documentation/media/kapi/dtv-net.rst

-- 
2.13.5

             reply	other threads:[~2017-09-27 21:40 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-27 21:40 Mauro Carvalho Chehab [this message]
2017-09-27 21:40 ` [PATCH v2 01/37] media: dvb_frontend: only use kref after initialized Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 02/37] media: stv0288: get rid of set_property boilerplate Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 03/37] media: stv6110: get rid of a srate dead code Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 04/37] media: friio-fe: get rid of set_property() Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 05/37] media: dvb_frontend: get rid of get_property() callback Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 06/37] media: dvb_frontend: get rid of set_property() callback Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 07/37] media: dvb_frontend: cleanup dvb_frontend_ioctl_properties() Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 08/37] media: dvb_frontend: cleanup ioctl handling logic Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 09/37] media: dvb_frontend: get rid of property cache's state Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 10/37] media: dvb_frontend.h: fix alignment at the cache properties Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 11/37] media: dvb_frontend: better document the -EPERM condition Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 12/37] media: dvb_frontend: fix return values for FE_SET_PROPERTY Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 13/37] media: dvbdev: convert DVB device types into an enum Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 14/37] media: dvbdev: fully document its functions Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 15/37] media: dvb_frontend.h: improve kernel-doc markups Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 16/37] media: dtv-core.rst: add chapters and introductory tests for common parts Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 17/37] media: dtv-core.rst: split into multiple files Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 18/37] media: dtv-demux.rst: minor markup improvements Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 19/37] media: dvb_demux.h: add an enum for DMX_TYPE_* and document Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 20/37] media: dvb_demux.h: add an enum for DMX_STATE_* " Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 21/37] media: dvb_demux.h: get rid of unused timer at struct dvb_demux_filter Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 22/37] media: dvb_demux: mark a boolean field as such Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 23/37] media: dvb_demux: dvb_demux_feed.pusi_seen is boolean Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 24/37] media: dvb_demux.h: get rid of DMX_FEED_ENTRY() macro Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 25/37] media: dvb_demux: fix type of dvb_demux_feed.ts_type Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 26/37] media: dvb_demux: document dvb_demux_filter and dvb_demux_feed Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 27/37] media: dvb_frontend: dtv_property_process_set() cleanups Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 28/37] media: dvb_frontend: get rid of dtv_get_property_dump() Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 29/37] media: dvb_demux.h: document structs defined on it Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 30/37] media: dvb_demux.h: document functions Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 31/37] media: dmxdev.h: add kernel-doc markups for data types and functions Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 32/37] media: dtv-demux.rst: parse other demux headers with kernel-doc Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 33/37] media: dvb-net.rst: document DVB network kAPI interface Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 34/37] media: dvb uAPI docs: get rid of examples section Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 35/37] media: dmxdev: use the newly nested kernel-doc support Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 36/37] media: dvb_demux: " Mauro Carvalho Chehab
2017-09-27 21:40 ` [PATCH v2 37/37] media: frontend: " Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1506547906.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).