1. 22 Sep, 2016 3 commits
    • Mauro Carvalho Chehab's avatar
      [media] get rid of a number of problems at the cross references · e383ce07
      Mauro Carvalho Chehab authored
      As warned by linuxdoc[1] tool, using:
      
      $ for i in $(git grep kernel-doc Documentation/media/kapi/|cut -d: -f4); do kernel-lintdoc --sloppy $i; done
      
          include/media/v4l2-dev.h:118 :WARN: function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
          include/media/v4l2-mc.h:56 [kernel-doc WARN] : enum name from comment differs:  if_vid_dec_index <--> if_vid_dec_pad_index
          include/media/v4l2-mc.h:71 [kernel-doc WARN] : enum name from comment differs:  if_aud_dec_index <--> if_aud_dec_pad_index
          include/media/v4l2-mem2mem.h:396 [kernel-doc WARN] : function name from comment differs:  v4l2_m2m_num_src_bufs_ready <--> v4l2_m2m_num_dst_bufs_ready
          drivers/media/dvb-core/dvb_math.h:28 [kernel-doc WARN] : function name from comment differs:  cintlog2 <--> intlog2
          include/media/v4l2-subdev.h:215 [kernel-doc WARN] : struct name from comment differs:  s_radio <--> v4l2_subdev_tuner_ops
          include/media/v4l2-subdev.h:890 [kernel-doc WARN] : function name from comment differs:  v4l2_set_subdevdata <--> v4l2_set_subdev_hostdata
          include/media/v4l2-subdev.h:901 [kernel-doc WARN] : function name from comment differs:  v4l2_get_subdevdata <--> v4l2_get_subdev_hostdata
          drivers/media/dvb-core/dvb_ringbuffer.h:196 [kernel-doc WARN] : function name from comment differs:  dvb_ringbuffer_writeuser <--> dvb_ringbuffer_write_user
          include/media/videobuf2-core.h:399 [kernel-doc WARN] : struct name from comment differs:  vb2_ops <--> vb2_buf_ops
          include/media/media-entity.h:132 [kernel-doc ERROR] : duplicate parameter definition 'source'
          include/media/media-entity.h:477 [kernel-doc WARN] : function name from comment differs:  media_entity_enum_test <--> media_entity_enum_test_and_set
          include/media/media-entity.h:535 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_pad
          include/media/media-entity.h:544 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_link
          include/media/media-entity.h:553 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_intf
          include/media/media-entity.h:562 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> intf_to_devnode
          include/media/rc-core.h:234 [kernel-doc WARN] : function name from comment differs:  rc_open <--> rc_close
          include/media/v4l2-ctrls.h:397 [kernel-doc WARN] : missing initial short description of 'v4l2_ctrl_handler_init'
          include/media/v4l2-dev.h:118 [kernel-doc WARN] : function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
          include/media/v4l2-event.h:225 [kernel-doc WARN] : missing initial short description of 'v4l2_src_change_event_subscribe'
      
      [1] https://return42.github.io/linuxdoc/linux.html
      
      The above are real issues at the documentation. On several cases,
      caused by cut-and-paste.
      
       Fix them.
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
      e383ce07
    • Laurent Pinchart's avatar
      [media] v4l: doc: Remove row numbers from tables · c2b66caf
      Laurent Pinchart authored
      Shorten the tables by removing row numbers in comments, allowing for
      later insertion of rows with minimal diffs.
      
      All changes have been generated by the following script.
      
      import io
      import re
      import sys
      
      def process_table(fname, data):
      	if fname.endswith('hist-v4l2.rst'):
      		data = re.sub(u'\n{1,2}\t( ?)  -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE)
      		data = re.sub(u'\n(\t|       )-  \.\. row [0-9]+\n\t  ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE)
      	else:
      		data = re.sub(u'\n{1,2}       -( ?) ?', u'\n      -\\1', data, flags = re.MULTILINE)
      		data = re.sub(u'(\n?)(\n\n    -  \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE)
      		data = re.sub(u'\n    -  \.\. row [0-9]+\n      -( ?) ?', u'    * -\\1', data, flags = re.MULTILINE)
      		data = re.sub(u'\n    -  \.\. row [0-9]+\n       \.\. (_[A-Z0-9_`-]*:)', u'\n    -  .. \\1', data, flags = re.MULTILINE)
      		data = re.sub(u'\n    -  \.\. (_[A-Z0-9_`-]*:)\n      -', u'    * .. \\1\n\n      -', data, flags = re.MULTILINE)
      		data = re.sub(u'^       - ', u'      -', data, flags = re.MULTILINE)
      		data = re.sub(u'^(\t{1,2})  ', u'\\1', data, flags = re.MULTILINE)
      
      	return data
      
      def process_file(fname, data):
      	buf = io.StringIO(data)
      	output = ''
      	in_table = False
      	table_separator = 0
      
      	for line in buf.readlines():
      		if line.find('.. flat-table::') != -1:
      			in_table = True
      			table = ''
      		elif in_table and not re.match('^[\t\n]|(    )', line):
      			in_table = False
      			output += process_table(fname, table)
      
      		if in_table:
      			table += line
      		else:
      			output += line
      
      	if in_table:
      		in_table = False
      		output += process_table(fname, table)
      
      	return output
      
      fname = sys.argv[1]
      
      data = file(fname, 'rb').read().decode('utf-8')
      data = process_file(fname, data)
      file(fname, 'wb').write(data.encode('utf-8'))
      Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
      c2b66caf
    • Laurent Pinchart's avatar
      [media] v4l: doc: Prepare for table reorganization · c1958488
      Laurent Pinchart authored
      Fix a few indentation issues to enable automated table reorganization
      by a regex-based script.
      Signed-off-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
      Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
      c1958488
  2. 19 Sep, 2016 37 commits