aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/Makefile
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-05-31 15:27:44 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:05 -0400
commit4266129964b8238526936d723de65b419d8069c6 (patch)
tree38c6b5cd3dc99b8599391ffad3b87e399bef56a2 /Documentation/DocBook/Makefile
parent04893043ae9ea8aa82b712491ed25ba6c4ffbca3 (diff)
[media] DocBook: Move all media docbook stuff into its own directory
This patch addresses several issues pointed by Randy Dunlap <rdunlap@xenotime.net> at changeset ece722c: - In the generated index.html file, "media" is listed first, but it should be listed in alphabetical order, not first. - The generated files are (hidden) in .tmpmedia/ - The link from the top-level index.html file to "media" is to media/index.html, but the file is actually in .tmpmedia/media/index.html - Please build docs with and without using "O=builddir" and test that. - Would it be possible for media to have its own Makefile instead of merging into this one? Due to the way cleandocs target works, I had to rename the media DocBook to media_api, otherwise cleandocs would remove the /media directory. Thanks-to: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook/Makefile')
-rw-r--r--Documentation/DocBook/Makefile261
1 files changed, 6 insertions, 255 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 595bdd3acb6d..5125277bd6a4 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -6,8 +6,6 @@
6# To add a new book the only step required is to add the book to the 6# To add a new book the only step required is to add the book to the
7# list of DOCBOOKS. 7# list of DOCBOOKS.
8 8
9TMPMEDIA=.tmpmedia
10
11DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ 9DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
12 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ 10 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
13 writing_usb_driver.xml networking.xml \ 11 writing_usb_driver.xml networking.xml \
@@ -16,7 +14,9 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
16 genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ 14 genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
17 80211.xml debugobjects.xml sh.xml regulator.xml \ 15 80211.xml debugobjects.xml sh.xml regulator.xml \
18 alsa-driver-api.xml writing-an-alsa-driver.xml \ 16 alsa-driver-api.xml writing-an-alsa-driver.xml \
19 tracepoint.xml $(TMPMEDIA)/media.xml drm.xml 17 tracepoint.xml drm.xml media_api.xml
18
19include $(srctree)/Documentation/DocBook/media/Makefile
20 20
21### 21###
22# The build process is as follows (targets): 22# The build process is as follows (targets):
@@ -34,7 +34,7 @@ PS_METHOD = $(prefer-db2x)
34 34
35### 35###
36# The targets that may be used. 36# The targets that may be used.
37PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs mediaprep 37PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
38 38
39BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) 39BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
40xmldocs: $(BOOKS) 40xmldocs: $(BOOKS)
@@ -228,9 +228,9 @@ clean-files := $(DOCBOOKS) \
228 $(patsubst %.xml, %.9, $(DOCBOOKS)) \ 228 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
229 $(index) 229 $(index)
230 230
231clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man $(MEDIA_DIR) 231clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
232 232
233cleandocs: 233cleandocs: cleanmediadocs
234 $(Q)rm -f $(call objectify, $(clean-files)) 234 $(Q)rm -f $(call objectify, $(clean-files))
235 $(Q)rm -rf $(call objectify, $(clean-dirs)) 235 $(Q)rm -rf $(call objectify, $(clean-dirs))
236 236
@@ -238,252 +238,3 @@ cleandocs:
238# information in a variable se we can use it in if_changed and friends. 238# information in a variable se we can use it in if_changed and friends.
239 239
240.PHONY: $(PHONY) 240.PHONY: $(PHONY)
241
242
243#
244# Media build rules - Auto-generates media contents/indexes and *.h xml's
245#
246
247SHELL=/bin/bash
248
249MEDIA_DIR=$(objtree)/Documentation/DocBook/$(TMPMEDIA)
250
251V4L_SGMLS = \
252 $(shell ls $(srctree)/Documentation/DocBook/v4l/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)') \
253 capture.c.xml \
254 keytable.c.xml \
255 v4l2grab.c.xml
256
257DVB_SGMLS = \
258 $(shell ls $(srctree)/Documentation/DocBook/dvb/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)')
259
260MEDIA_TEMP = media-entities.tmpl \
261 media-indices.tmpl \
262 videodev2.h.xml \
263 frontend.h.xml
264
265MEDIA_SGMLS = $(addprefix ./,$(V4L_SGMLS)) $(addprefix ./,$(DVB_SGMLS)) $(addprefix ./,$(MEDIA_TEMP))
266
267MEDIA_TEMP_OBJ := $(addprefix $(MEDIA_DIR)/,$(MEDIA_TEMP))
268
269FUNCS = \
270 close \
271 ioctl \
272 mmap \
273 munmap \
274 open \
275 poll \
276 read \
277 select \
278 write \
279
280IOCTLS = \
281 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
282 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
283 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
284 VIDIOC_SUBDEV_G_FRAME_INTERVAL \
285 VIDIOC_SUBDEV_S_FRAME_INTERVAL \
286 VIDIOC_SUBDEV_ENUM_MBUS_CODE \
287 VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
288 VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \
289
290TYPES = \
291 $(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/linux/videodev2.h)
292
293ENUMS = \
294 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
295 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
296 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
297 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)
298
299STRUCTS = \
300 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
301 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
302 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
303 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)
304
305ERRORS = \
306 EACCES \
307 EAGAIN \
308 EBADF \
309 EBUSY \
310 EFAULT \
311 EIO \
312 EINTR \
313 EINVAL \
314 ENFILE \
315 ENOMEM \
316 ENOSPC \
317 ENOTTY \
318 ENXIO \
319 EMFILE \
320 EPERM \
321 ERANGE \
322 EPIPE \
323
324ESCAPE = \
325 -e "s/&/\\&amp;/g" \
326 -e "s/</\\&lt;/g" \
327 -e "s/>/\\&gt;/g"
328
329FILENAME = \
330 -e s,"^[^\/]*/",, \
331 -e s/"\\.xml"// \
332 -e s/"\\.tmpl"// \
333 -e s/\\\./-/g \
334 -e s/"^func-"// \
335 -e s/"^pixfmt-"// \
336 -e s/"^vidioc-"//
337
338# Generate references to these structs in videodev2.h.xml.
339DOCUMENTED = \
340 -e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \
341 -e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \
342 -e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \
343 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
344 -e "s/v4l2\-mpeg\-vbi\-ITV0/v4l2-mpeg-vbi-itv0-1/g"
345
346DVB_DOCUMENTED = \
347 -e "s,\(define \)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
348 -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g"
349
350
351#
352# Media targets and dependencies
353#
354
355$(obj)/$(TMPMEDIA)/media.xml: $(obj)/media.tmpl $(MEDIA_TEMP_OBJ) FORCE
356 $(call if_changed_rule,docproc)
357
358$(MEDIA_DIR)/v4l2.xml:
359 @$($(quiet)gen_xml)
360 @(mkdir -p $(MEDIA_DIR))
361 @(cp $(srctree)/Documentation/DocBook/dvb/*.png $(srctree)/Documentation/DocBook/v4l/*.gif $(MEDIA_DIR)/)
362 @(ln -sf $(srctree)/Documentation/DocBook/v4l/*xml $(MEDIA_DIR)/)
363 @(ln -sf $(srctree)/Documentation/DocBook/dvb/*xml $(MEDIA_DIR)/)
364
365$(MEDIA_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_DIR)/v4l2.xml
366 @$($(quiet)gen_xml)
367 @( \
368 echo "<programlisting>") > $@
369 @( \
370 expand --tabs=8 < $< | \
371 sed $(ESCAPE) $(DOCUMENTED) | \
372 sed 's/i\.e\./&ie;/') >> $@
373 @( \
374 echo "</programlisting>") >> $@
375
376$(MEDIA_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_DIR)/v4l2.xml
377 @$($(quiet)gen_xml)
378 @( \
379 echo "<programlisting>") > $@
380 @( \
381 expand --tabs=8 < $< | \
382 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
383 sed 's/i\.e\./&ie;/') >> $@
384 @( \
385 echo "</programlisting>") >> $@
386
387$(MEDIA_DIR)/media-entities.tmpl: $(MEDIA_DIR)/v4l2.xml
388 @$($(quiet)gen_xml)
389 @( \
390 echo "<!-- Generated file! Do not edit. -->") >$@
391 @( \
392 echo -e "\n<!-- Functions -->") >>$@
393 @( \
394 for ident in $(FUNCS) ; do \
395 entity=`echo $$ident | tr _ -` ; \
396 echo "<!ENTITY func-$$entity \"<link" \
397 "linkend='func-$$entity'><function>$$ident()</function></link>\">" \
398 >>$@ ; \
399 done)
400 @( \
401 echo -e "\n<!-- Ioctls -->") >>$@
402 @( \
403 for ident in $(IOCTLS) ; do \
404 entity=`echo $$ident | tr _ -` ; \
405 id=`grep "<refname>$$ident" $(MEDIA_DIR)/vidioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
406 echo "<!ENTITY $$entity \"<link" \
407 "linkend='$$id'><constant>$$ident</constant></link>\">" \
408 >>$@ ; \
409 done)
410 @( \
411 echo -e "\n<!-- Types -->") >>$@
412 @( \
413 for ident in $(TYPES) ; do \
414 entity=`echo $$ident | tr _ -` ; \
415 echo "<!ENTITY $$entity \"<link" \
416 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
417 done)
418 @( \
419 echo -e "\n<!-- Enums -->") >>$@
420 @( \
421 for ident in $(ENUMS) ; do \
422 entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \
423 echo "<!ENTITY $$entity \"enum&nbsp;<link" \
424 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
425 done)
426 @( \
427 echo -e "\n<!-- Structures -->") >>$@
428 @( \
429 for ident in $(STRUCTS) ; do \
430 entity=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
431 echo "<!ENTITY $$entity \"struct&nbsp;<link" \
432 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
433 done)
434 @( \
435 echo -e "\n<!-- Error Codes -->") >>$@
436 @( \
437 for ident in $(ERRORS) ; do \
438 echo "<!ENTITY $$ident \"<errorcode>$$ident</errorcode>" \
439 "error code\">" >>$@ ; \
440 done)
441 @( \
442 echo -e "\n<!-- Subsections -->") >>$@
443 @( \
444 for file in $(MEDIA_SGMLS) ; do \
445 entity=`echo "$$file" | sed $(FILENAME) -e s/"^([^-]*)"/sub\1/` ; \
446 if ! echo "$$file" | \
447 grep -q -E -e '^(func|vidioc|pixfmt)-' ; then \
448 echo "<!ENTITY sub-$$entity SYSTEM \"$$file\">" >>$@ ; \
449 fi ; \
450 done)
451 @( \
452 echo -e "\n<!-- Function Reference -->") >>$@
453 @( \
454 for file in $(MEDIA_SGMLS) ; do \
455 if echo "$$file" | \
456 grep -q -E -e '(func|vidioc|pixfmt)-' ; then \
457 entity=`echo "$$file" |sed $(FILENAME)` ; \
458 echo "<!ENTITY $$entity SYSTEM \"$$file\">" >>$@ ; \
459 fi ; \
460 done)
461
462# Jade can auto-generate a list-of-tables, which includes all structs,
463# but we only want data types, all types, and sorted please.
464$(MEDIA_DIR)/media-indices.tmpl: $(MEDIA_DIR)/v4l2.xml
465 @$($(quiet)gen_xml)
466 @( \
467 echo "<!-- Generated file! Do not edit. -->") >$@
468 @( \
469 echo -e "\n<index><title>List of Types</title>") >>$@
470 @( \
471 for ident in $(TYPES) ; do \
472 id=`echo $$ident | tr _ -` ; \
473 echo "<indexentry><primaryie><link" \
474 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
475 done)
476 @( \
477 for ident in $(ENUMS) ; do \
478 id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \
479 echo "<indexentry><primaryie>enum&nbsp;<link" \
480 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
481 done)
482 @( \
483 for ident in $(STRUCTS) ; do \
484 id=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
485 echo "<indexentry><primaryie>struct&nbsp;<link" \
486 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
487 done)
488 @( \
489 echo "</index>") >>$@
generated by cgit v1.2.2 (git 2.25.0) at 2025-02-10 00:25:41 -0500