[media] DocBook: Improve xref check for undocumented ioctls
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 26 May 2015 15:42:08 +0000 (12:42 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sat, 30 May 2015 11:42:59 +0000 (08:42 -0300)
There are several badly documented undocumented ioctls.
Currently, it just generates an empty link. Instead of doing that,
only add references to the ones that exists, and add a warning
for all references that weren't found.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/Makefile

index 723932f..fdb0027 100644 (file)
@@ -305,10 +305,12 @@ $(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
        @(                                                              \
        for ident in $(IOCTLS) ; do                                     \
          entity=`echo $$ident | tr _ -` ;                              \
-         id=`grep "<refname>$$ident" $(MEDIA_OBJ_DIR)/vidioc-*.xml $(MEDIA_OBJ_DIR)/media-ioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
-         echo "<!ENTITY $$entity \"<link"                              \
+         id=`grep -e "<refname>$$ident" -e "<section id=\"$$ident\"" $$(find $(MEDIA_SRC_DIR) -name *.xml -type f)| sed -r s,"^.*/(.*).xml.*","\1",` ; \
+         if [ "$$id" != "" ]; then echo "<!ENTITY $$entity \"<link"    \
            "linkend='$$id'><constant>$$ident</constant></link>\">"     \
-         >>$@ ;                                                        \
+         >>$@ ; else                                                   \
+               echo "Warning: undocumented ioctl: $$ident. Please document it at the media DocBook!" >&2;      \
+         fi;                                                           \
        done)
        @(                                                              \
        echo -e "\n<!-- Defines -->") >>$@