summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-07 14:28:43 +0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-07 14:33:38 +0300
commit0c02966b1338478d6a216824376c2eee0aae78d0 (patch)
tree878061c5e415afdb84ff70fc28682afe4092f720 /Documentation
parent34fb803092222d22073a6eed2fd7a7f7d2cda484 (diff)
downloadlinux-0c02966b1338478d6a216824376c2eee0aae78d0.tar.xz
doc-rst: auto-generate net.h.rst
This file comes from the uAPI definition header, and should be auto-generated, to be in sync with Kernel changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/linux_tv/Makefile10
-rw-r--r--Documentation/linux_tv/net.h.rst59
-rw-r--r--Documentation/linux_tv/net.h.rst.exceptions11
3 files changed, 18 insertions, 62 deletions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 7ee14195802f..4ec743449776 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -2,8 +2,9 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
+TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst
-htmldocs: audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst
+htmldocs: ${TARGETS}
audio.h.rst: ${PARSER} ${UAPI}/dvb/audio.h audio.h.rst.exceptions
${PARSER} ${UAPI}/dvb/audio.h $@ audio.h.rst.exceptions
@@ -17,5 +18,8 @@ dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
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
+net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/net.h $@ net.h.rst.exceptions
+
+cleandocs:
+ -rm ${TARGETS}
diff --git a/Documentation/linux_tv/net.h.rst b/Documentation/linux_tv/net.h.rst
deleted file mode 100644
index 9b0f705c634b..000000000000
--- a/Documentation/linux_tv/net.h.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: net.h
-===========
-
-.. code-block:: c
-
- /*
- * net.h
- *
- * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
- * & Ralph Metzler <ralph@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _DVBNET_H_
- #define _DVBNET_H_
-
- #include <linux/types.h>
-
- struct dvb_net_if {
- __u16 pid;
- __u16 if_num;
- __u8 feedtype;
- #define DVB_NET_FEEDTYPE_MPE 0 /* multi protocol encapsulation */
- #define DVB_NET_FEEDTYPE_ULE 1 /* ultra lightweight encapsulation */
- };
-
-
- #define NET_ADD_IF _IOWR('o', 52, struct dvb_net_if)
- #define NET_REMOVE_IF _IO('o', 53)
- #define NET_GET_IF _IOWR('o', 54, struct dvb_net_if)
-
-
- /* binary compatibility cruft: */
- struct __dvb_net_if_old {
- __u16 pid;
- __u16 if_num;
- };
- #define __NET_ADD_IF_OLD _IOWR('o', 52, struct __dvb_net_if_old)
- #define __NET_GET_IF_OLD _IOWR('o', 54, struct __dvb_net_if_old)
-
-
- #endif /*_DVBNET_H_*/
diff --git a/Documentation/linux_tv/net.h.rst.exceptions b/Documentation/linux_tv/net.h.rst.exceptions
new file mode 100644
index 000000000000..30a267483aa9
--- /dev/null
+++ b/Documentation/linux_tv/net.h.rst.exceptions
@@ -0,0 +1,11 @@
+# Ignore header name
+ignore define _DVBNET_H_
+
+# Ignore old ioctls/structs
+ignore ioctl __NET_ADD_IF_OLD
+ignore ioctl __NET_GET_IF_OLD
+ignore struct __dvb_net_if_old
+
+# Macros used at struct dvb_net_if
+replace define DVB_NET_FEEDTYPE_MPE dvb-net-if
+replace define DVB_NET_FEEDTYPE_ULE dvb-net-if