Commit 1ae64395 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: auto-build the frontend.h.rst 



This file is auto-generated with DocBook, from the uapi header.

Do the same with Sphinx.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent dabf8be3

Documentation/Makefile.sphinx

+1 −0
Original line number Diff line number Diff line
@@ -35,6 +35,7 @@ quiet_cmd_sphinx = SPHINX $@ 
      cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2



htmldocs:

	$(MAKE) -C $(srctree)/Documentation/linux_tv $@

	$(call cmd,sphinx,html)



pdfdocs:

Documentation/linux_tv/Makefile

0 → 100644
+12 −0
Original line number Diff line number Diff line 
# Generate the *.h.rst files from uAPI headers



PARSER = ../sphinx/parse-headers.pl

UAPI = ../../include/uapi/linux



htmldocs: frontend.h.rst



frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h  frontend.h.rst.exceptions

	${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions



clean:

	-rm frontend.h.rst

Documentation/linux_tv/frontend.h.rst

deleted100644 → 0
+0 −609

File deleted.

Preview size limit exceeded, changes collapsed.

Documentation/linux_tv/frontend.h.rst.exceptions

0 → 100644
+47 −0
Original line number Diff line number Diff line 
# Ignore header name

ignore define _DVBFRONTEND_H_



# Group layer A-C symbols together

replace define DTV_ISDBT_LAYERA_FEC dtv-isdbt-layer-fec

replace define DTV_ISDBT_LAYERB_FEC dtv-isdbt-layer-fec

replace define DTV_ISDBT_LAYERC_FEC dtv-isdbt-layer-fec

replace define DTV_ISDBT_LAYERA_MODULATION dtv-isdbt-layer-modulation

replace define DTV_ISDBT_LAYERB_MODULATION dtv-isdbt-layer-modulation

replace define DTV_ISDBT_LAYERC_MODULATION dtv-isdbt-layer-modulation

replace define DTV_ISDBT_LAYERA_SEGMENT_COUNT dtv-isdbt-layer-segment-count

replace define DTV_ISDBT_LAYERB_SEGMENT_COUNT dtv-isdbt-layer-segment-count

replace define DTV_ISDBT_LAYERC_SEGMENT_COUNT dtv-isdbt-layer-segment-count

replace define DTV_ISDBT_LAYERA_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving

replace define DTV_ISDBT_LAYERB_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving

replace define DTV_ISDBT_LAYERC_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving



# Ignore legacy defines

ignore define DTV_ISDBS_TS_ID_LEGACY

ignore define SYS_DVBC_ANNEX_AC

ignore define SYS_DMBTH



# Ignore limits

ignore define DTV_MAX_COMMAND

ignore define MAX_DTV_STATS

ignore define DTV_IOCTL_MAX_MSGS



# Stats enum is documented altogether

replace enum fecap_scale_params frontend-stat-properties

replace symbol FE_SCALE_COUNTER frontend-stat-properties

replace symbol FE_SCALE_DECIBEL frontend-stat-properties

replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties

replace symbol FE_SCALE_RELATIVE frontend-stat-properties



# the same reference is used for both get and set ioctls

replace ioctl FE_SET_PROPERTY FE_GET_PROPERTY



# Ignore struct used only internally at Kernel

ignore struct dtv_cmds_h



# Typedefs that use the enum reference

replace typedef fe_sec_voltage_t fe-sec-voltage



# Replaces for flag constants

replace define FE_TUNE_MODE_ONESHOT fe_set_frontend_tune_mode

replace define LNA_AUTO dtv-lna

replace define NO_STREAM_ID_FILTER dtv-stream-id