Commit Graph

70 Commits

Author SHA1 Message Date
Michael Niedermayer
ffed7227c3 Revert "doc: add script to compute texi files dependencies"
This reverts commit 628ceac652.

The commit broke out of tree builds
2013-07-03 12:59:59 +02:00
Stefano Sabatini
628ceac652 doc: add script to compute texi files dependencies
Replace the inline awk script with a Perl script which tracks the
dependencies recursively.

This allows to correctly track dependencies for files including files
with a second level include (for example: ffmpeg-devices.texi ->
devices.texi -> outdevs.texi).

This also adds a dependency on perl for computing the dependencies, which
should not be a problem since perl is already required all the way for
building documentation.
2013-07-03 11:25:45 +02:00
Stefano Sabatini
be3f4c13b6 doc/Makefile: install .3 man pages to man3 subdir
Fix trac ticket #2585.
2013-05-19 19:26:25 +02:00
Stefano Sabatini
90cb081f88 build: drop unused ALLMANPAGES variable 2013-05-19 19:26:21 +02:00
Stefano Sabatini
9b4d9d8795 doc: enable compilation of -all tool pages
In particular, add documentation configuration system, through the
doc/config.texi file.

Fix trac issue #2374.
2013-04-05 10:11:57 +02:00
Michael Niedermayer
70b0aeba00 Merge commit '7a95afe433b2a692f490b98948c082e62ffc1d27'
* commit '7a95afe433b2a692f490b98948c082e62ffc1d27':
  doc: fix dependencies in pod generation

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-24 14:35:15 +01:00
Luca Barbato
7a95afe433 doc: fix dependencies in pod generation
The script can and will change.
2013-01-24 10:43:15 +01:00
James Almer
4f8b73129b doc/Makefile: Fix make docclean
Signed-off-by: James Almer <jamrial@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-19 14:32:29 +01:00
Clément Bœsch
00ebac6dfd doc: stop generating syntax.html.
Just like doc/eval.texi, this file is meant to be included from
ffmpeg-utils.texi, and not to be used as a standalone documentation.
2012-12-24 00:53:55 +01:00
Stefano Sabatini
9bba683578 doc/Makefile: add docclean rule
This allows to clean the doc directory from the parent project dir.
The command:
make -C doc clean

does not work as long as the paths specified in doc/Makefile are relative
to the parent dir.

Also it is consitent with "testclean" and "distclean" targets.
2012-12-18 00:06:17 +01:00
Stefano Sabatini
cf56c20761 doc/Makefile: rework component configuration logic
Only enable component manual when the corresponding library providing
the feature is enabled.
2012-11-29 10:19:52 +01:00
Stefano Sabatini
5ddc072d0d doc: add ffmpeg-bitstream-filters.texi file 2012-11-28 23:51:12 +01:00
Stefano Sabatini
3a227f5d90 doc: add ffmpeg-protocols.texi manual 2012-11-27 23:35:45 +01:00
Stefano Sabatini
9c492271a8 doc: move syntax and eval chapters from libavutil to ffmpeg-utils
Move utilities description to a dedicated manual, consistent with what I
did with the rest of the documentation.
2012-11-27 23:35:35 +01:00
Stefano Sabatini
d82331721e doc: add libavdevice.texi and ffmpeg-devices.texi files 2012-11-27 23:35:25 +01:00
Stefano Sabatini
8ddeae5ae7 doc: add libavformat.texi and ffmpeg-formats.texi files 2012-11-27 23:35:19 +01:00
Stefano Sabatini
cf6c6134cd doc: add libswscale.texi and ffmpeg-scaler.texi files 2012-11-25 19:21:30 +01:00
Stefano Sabatini
e903cb4194 doc: add libswresample.texi and ffmpeg-resampler.texi files 2012-11-25 00:28:36 +01:00
Stefano Sabatini
f62abbf3b7 doc: move filters documentation to dedicated manual page ffmpeg-filters 2012-11-25 00:28:27 +01:00
Stefano Sabatini
fa4ead1d66 doc: move codec options and descriptions to a dedicated manual page 2012-11-25 00:27:07 +01:00
Stefano Sabatini
c0aff4064d doc/Makefile: generate library headers with the correct section number 2012-11-11 14:06:27 +01:00
Stefano Sabatini
514910fb2d doc: add libavfilter.texi
With some re-wording by Alexander Strasser <eclipse7@gmx.net>.
2012-11-11 11:15:53 +01:00
Stefano Sabatini
598546e1df doc: add libavutil.texi
With some fixes and better wording by Alexander Strasser
<eclipse7@gmx.net>.
2012-11-11 11:15:53 +01:00
Stefano Sabatini
58d1d7024d doc/Makefile: change DOCLIBS check
More consistent with the rest of the build system, and more compact.
2012-11-07 23:18:11 +01:00
Stefano Sabatini
a1934daeb4 doc/Makefile: remove .3 file with make clean 2012-11-06 12:23:13 +01:00
Stefano Sabatini
617d0d41a2 doc: add libavcodec.texi
The option chapter is based on the avoptions_codec.texi auto-generated
file.
2012-11-04 11:54:57 +01:00
Michael Niedermayer
2581d9bcbb Merge remote-tracking branch 'qatar/master'
* qatar/master:
  doc: add apidoc target for doxygen API documentation
  matroskadec: do not use avpacket internals

Conflicts:
	doc/Makefile
	libavformat/matroskadec.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-11-03 14:48:51 +01:00
Janne Grunau
b3fab1f2cd doc: add apidoc target for doxygen API documentation
Documentation includes only the externally visible API of the installed
headers.

Based on a patch by Anton Khirnov <anton@khirnov.net>.

Signed-off-by: Anton Khirnov <anton@khirnov.net>
2012-11-02 18:28:56 +01:00
Michael Niedermayer
52dc18d414 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  x86: vc1: call ff_vc1dsp_init_x86() under if (ARCH_X86)
  x86: cavs: call ff_cavsdsp_init_x86() under if (ARCH_X86)
  x86: call most of the x86 dsp init functions under if (ARCH_X86)
  doc: support the new website layout
  doc: remove a warning from filters.texi
  doc: initial nut documentation
  segment: drop global headers setting
  lavu: fix typo in Makefile

Conflicts:
	doc/Makefile
	doc/filters.texi
	doc/t2h.init
	libavcodec/fmtconvert.c
	libavcodec/proresdsp.c
	libavcodec/x86/Makefile
	libavcodec/x86/vc1dsp_mmx.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-10-08 21:46:34 +02:00
Luca Barbato
175d0d94da doc: initial nut documentation 2012-10-08 11:22:42 +02:00
Stefano Sabatini
8e2cf68d09 doc/Makefile: add doc target, as an alias for "documentation"
Consistent with --enable-doc, and easier to type.
2012-08-18 10:04:25 +02:00
Stefano Sabatini
c3da2c19e4 build: extend documentation building mechanism
Allow to select specific documentation components, and reliably check for
component dependencies.

In particular, check for perl presence on the system.
2012-08-13 12:22:02 +02:00
Stefano Sabatini
e874b29296 doc/Makefile: invoke perl to interpret texi2pod.pl
Do not rely on shebang directive in the script, whose exact behavior is
system dependent.
2012-08-10 23:14:57 +02:00
Michael Niedermayer
c6963a220d Merge remote-tracking branch 'qatar/master'
* qatar/master:
  proresdsp: port x86 assembly to cpuflags.
  lavr: x86: improve non-SSE4 version of S16_TO_S32_SX macro
  lavfi: better channel layout negotiation
  alac: check for truncated packets
  alac: reverse lpc coeff order, simplify filter
  lavr: add x86-optimized mixing functions
  x86: add support for fmaddps fma4 instruction with abstraction to avx/sse
  tscc2: fix typo in array index
  build: use COMPILE template for HOSTOBJS
  build: do full flag handling for all compiler-type tools
  eval: fix printing of NaN in eval fate test.
  build: Rename aandct component to more descriptive aandcttables
  mpegaudio: bury inline asm under HAVE_INLINE_ASM.
  x86inc: automatically insert vzeroupper for YMM functions.
  rtmp: Check the buffer length of ping packets
  rtmp: Allow having more unknown data at the end of a chunk size packet without failing
  rtmp: Prevent reading outside of an allocate buffer when receiving server bandwidth packets

Conflicts:
	Makefile
	configure
	libavcodec/x86/proresdsp.asm
	libavutil/eval.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-07-27 23:42:19 +02:00
Mans Rullgard
b9d3c37848 build: use COMPILE template for HOSTOBJS
Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-07-26 23:58:59 +01:00
jamal
d48f014ff1 doc/Makefile: Add missing $(HOSTEXESUF) to print_options 2012-07-14 11:47:09 +02:00
jamal
3e03f8d8b2 build: Fix documentation dependencies and rules 2012-07-14 11:47:01 +02:00
Stefano Sabatini
5a6c7a218c doc: merge libavfilter.texi into filters.texi
There is no much point into splitting documentation for filters. Also
having a separate document for a library is inconsistent.
2012-07-14 11:38:53 +02:00
Stefano Sabatini
27127ebe6c doc: add syntax.texi file 2012-05-22 00:39:53 +02:00
Michael Niedermayer
d40ff29cac Merge remote-tracking branch 'qatar/master'
* qatar/master:
  asf: only set index_read if the index contained entries.
  cabac: add overread protection to BRANCHLESS_GET_CABAC().
  cabac: increment jump locations by one in callers of BRANCHLESS_GET_CABAC().
  cabac: remove unused argument from BRANCHLESS_GET_CABAC_UPDATE().
  cabac: use struct+offset instead of memory operand in BRANCHLESS_GET_CABAC().
  h264: add overread protection to get_cabac_bypass_sign_x86().
  h264: reindent get_cabac_bypass_sign_x86().
  h264: use struct offsets in get_cabac_bypass_sign_x86().
  h264: fix overreads in cabac reader.
  wmall: fix seeking.
  lagarith: fix buffer overreads.
  dvdec: drop unnecessary dv_tablegen.h #include
  build: fix doc generation errors in parallel builds
  Replace memset(0) by zero initializations.
  faandct: Remove FAAN_POSTSCALE define and related code.
  dvenc: print allowed profiles if the video doesn't conform to any of them.
  avcodec_encode_{audio,video}: only reallocate output packet when it has non-zero size.
  FATE: add a test for vp8 with changing frame size.
  fate: add kgv1 fate test.
  oggdec: calculate correct timestamps in Ogg/FLAC

Conflicts:
	libavcodec/4xm.c
	libavcodec/cook.c
	libavcodec/dvdata.c
	libavcodec/dvdsubdec.c
	libavcodec/lagarith.c
	libavcodec/lagarithrac.c
	libavcodec/utils.c
	tests/fate/video.mak

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-29 04:11:10 +02:00
Mans Rullgard
2efb710a34 build: fix doc generation errors in parallel builds
The $(dir) function used to construct OBJDIRS includes a trailing slash
in the names returned, which GNU make 3.82 does not match to the
slash-less 'doc' in the documentation dependencies, causing parallel
build to fail.  Adding a slash fixes this and still works with make
3.81.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-28 11:42:19 +01:00
Michael Niedermayer
7b453d1c60 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  westwood_vqa: fix SND0 chunk handling
  westwood_vqa: set video stream duration
  raw: forward avpicture_fill() error code in raw_decode().
  build: Do not explicitly add the doc directory to the OBJDIRS list.
  dv: Split off DV video decoder into its own file.
  build: fix RALF decoder standalone compilation, which depends on Golomb code
  configure: Drop stray duplicate entry for --disable-fft from help output.

Conflicts:
	libavcodec/dv.c
	libavcodec/rawdec.c
	libavformat/westwood_vqa.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-28 04:12:24 +02:00
Diego Biurrun
8e0b7e2f14 build: Do not explicitly add the doc directory to the OBJDIRS list.
Now that a documentation generator is built in the doc directory,
this is no longer necessary.  Fixes the Make warning:
Makefile:188: target `doc' given more than once in the same rule.
2012-03-27 11:15:47 +02:00
Michael Niedermayer
0ebd83617f Merge remote-tracking branch 'qatar/master'
* qatar/master: (27 commits)
  avconv: free packet in write_frame() when discarding due to frame number limit
  FATE: use +/- flag option syntax for vp8 emu-edge tests
  lavf: make av_interleave_packet_per_dts() private.
  lavf: deprecate av_read_packet().
  oggdec: output correct timestamps for Vorbis
  avconv: pass input stream timestamps to audio encoders
  lavc: shrink encoded audio packet size after encoding.
  xa: set correct bit rate
  xa: do not set bit_rate, block_align, or bits_per_coded_sample
  xa: fix end-of-file handling
  xa: fix timestamp calculation
  bink: fix typo in FFALIGN() argument
  bink: align plane width to 8 when calculating bundle sizes
  doc: pass -Idoc texi2html and texi2pod
  doc: texi2pod: add -I flag
  movenc: Add a min_frag_duration option
  rtsp: Set the default delay to 0.1 s for the RTSP/SDP/RTP demuxers
  libavformat: Set the default for the max_delay option to -1
  Generate manpages for AV{Format,Codec}Context AVOptions.
  doc/avconv: remove entries for AVOptions.
  ...

Conflicts:
	doc/Makefile
	doc/ffmpeg.texi
	doc/muxers.texi
	ffmpeg.c
	libavcodec/Makefile
	libavcodec/options.c
	libavcodec/vp8.c
	libavformat/options.c
	tests/fate/demux.mak
	tests/ref/fate/truemotion1-15
	tests/ref/fate/truemotion1-24

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-03-21 01:33:53 +01:00
Mans Rullgard
2ac3df858c doc: pass -Idoc texi2html and texi2pod
This fixes doc generation in build tree separate from source.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-20 11:10:25 +00:00
Anton Khirnov
0d0b81f941 Generate manpages for AV{Format,Codec}Context AVOptions. 2012-03-20 07:10:06 +01:00
Alexander Strasser
c7062802d9 doc: build: TEXIDEP: Recognize verbatim includes
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude) should also be taken into account.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-24 02:56:52 +01:00
Michael Niedermayer
c2c284b3eb Revert "doc: build: TEXIDEP: Recognize verbatim includes"
This reverts commit e5cbf24e45.

This commits breaks out of tree builds
2011-12-23 18:01:10 +01:00
Alexander Strasser
abab44086f doc: fate: Support building a plain text version
Also create a plain text (.txt) file from fate.texi if the makeinfo
program is available.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-20 16:05:01 +01:00
Alexander Strasser
e5cbf24e45 doc: build: TEXIDEP: Recognize verbatim includes
When generating the .dep files for .texi sources, verbatim includes
(@verbatiminclude) should also be taken into account.

Signed-off-by: Alexander Strasser <eclipse7@gmx.net>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2011-12-20 16:05:01 +01:00