24 Commits

Author SHA1 Message Date
Stefano Sabatini
4f74cb9334 doc/texi2pod.pl: skip printing chapter names if they are disabled
(cherry picked from commit c838701ce4515bd51f7827be0b20f256ba5c69f3)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
3726425d51 doc/texi2pod: rework man inclusion logic
Ignore @c man begin ... @c man end comments, rely on @chapter for marking
the beginning of the various manual top level sections.

This allows us to write markup which is not dependent on the specific
texi2pod.pl implementation.

This change causes a few rendering issues, which will be fixed in further
patches.
(cherry picked from commit ca3d786227adf20f4e19809090c980d6d1109bf8)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
bdeb7b6176 doc/texi2pod: fix @ref substitution rule, disallow "}" within the fields
Fix potential spurious substitution.
(cherry picked from commit 9167db3829f360f241255d4240ba6b7135ab4111)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
7231c30bff doc/texi2pod: fix warnings introduced in e7e14bc69a606a6bec82efef729263cd38f122d4
The variable "$section" was replaced by "$chapter".
(cherry picked from commit c0c06c1bba80c4bee162a3c40eec678ddc65571d)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Luca Barbato
6ec4cda182 doc: support multitable in texi2pod
(cherry picked from commit 5ea5ffc9cee1b91eed471fff2f51d771222cf8d2)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
ae224c924e doc/texipod: add rule to correctly interpret @ref{ANCHOR,XREF,SECTION_NAME,...}
This allows to name an internal reference in the POD/MAN output.
(cherry picked from commit c499d45c6bea8d7bbbb7a819c53fe9766136bf29)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
d56dd43c50 doc/texi2pod: correctly handle @url commands in the form @url{URL,...}
Ignore the other arguments, which have not to be processed by the POD
renderer.
(cherry picked from commit 1f9855dbc1102e63fa7ce932d0edf0d545c89b09)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
646bcc37e6 doc/texi2pod: add support to @ifhtml and @ifnothtml directives
With these commands it is possible to add HTML and non-HTML snippets,
which will be useful for the "See Also" manual chapters.
(cherry picked from commit f14e248783f45a698947a2ed6e2c82069db46bc8)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Nicolas George
6469c199b4 doc/texi2pod: recognize @table @command.
(cherry picked from commit ee2d6fbc92e6d55dda319fa56234c5be9a476728)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
f00e882a1f doc/texi2pod.pl: drop unnecessary rule, which was converting "\," to ","
I cannot find a reason for such a rule, which was resulting in badly
escaped filtergraph snippets.

Fix trac ticket #1610.
(cherry picked from commit ce875a613a16b06b0a561774955111f7a24d12bb)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Stefano Sabatini
e8cae38be6 doc/texi2pod: add "use warnings" directive
The script was previously run with perl -w through the shebang
command. Now that the script is executed through direct perl invocation
the -w in the shebang command is ignored. This patch re-enables "use
warnings" whatever way the script is invoked.

Idea-By: jamal <jamrial@gmail.com>
(cherry picked from commit 3239382aefd0f5fa9ffd1509ccaedd59a54ec9af)

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
2013-08-27 09:02:59 -07:00
Mans Rullgard
b8b207e896 doc: texi2pod: add -I flag
This allows specifying additional directories to search for
@include files.

Signed-off-by: Mans Rullgard <mans@mansr.com>
2012-03-20 11:10:25 +00:00
Diego Biurrun
4c98976124 doc: replace @pxref by @ref where appropriate 2011-07-09 21:53:59 +02:00
Justin Ruggles
7f0e747b8c support @heading, @subheading, @subsubheading, and @subsubsection in
texi2pod.pl
2011-03-25 09:48:31 -04:00
Stefano Sabatini
60445a0995 Remove @anchor{} commands from the POD output.
This allows to use the @xref{} command for the HTML output.

Originally committed as revision 25854 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-11-30 20:14:29 +00:00
Stefano Sabatini
4db960650c Make texi2pod.pl process @include texinfo directives wherever they are
placed, and not only if inside @c man begin/end sections.

Originally committed as revision 23544 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-08 23:03:16 +00:00
Stefano Sabatini
22cb270ca5 Tweak texi2pod.pl to make it print the various sections in the
generated document following the same order as that used in the texi
file.

Also allow rendering of *all* the sections, not only a limited
predefined subset.

Originally committed as revision 23543 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-08 23:03:14 +00:00
Stefano Sabatini
299b8be2ec Remove a rule triggered by @man begin WORD WORDS. This rule only
outputs the section if WORDS has been defined in the list of options
flags.

The meaning of this rule is not clear, and not used by the FFmpeg
documentation system anyway.

Originally committed as revision 23542 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-08 23:03:11 +00:00
Stefano Sabatini
19da45f22b Make texi2pod.pl look for section "AUTHORS" rather than "AUTHOR", as
the corresponding sections in the man page have been renamed that way.

Originally committed as revision 23493 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-05 17:00:23 +00:00
Stefano Sabatini
acbdbf815a Make texi2pod.pl accept @itemize commands with no following character
or texinfo command for specifying how to generate @item marks, and
make it use by default the mark symbol "*".

This is consistent with texinfo docs:
"If you don't specify a mark command, the default is `@bullet'."

Originally committed as revision 23408 to svn://svn.ffmpeg.org/ffmpeg/trunk
2010-06-01 14:00:42 +00:00
Diego Biurrun
5509bffa88 Update licensing information: The FSF changed postal address.
Originally committed as revision 4842 to svn://svn.ffmpeg.org/ffmpeg/trunk
2006-01-12 22:43:26 +00:00
Diego Biurrun
bb270c0896 COSMETICS: tabs --> spaces, some prettyprinting
Originally committed as revision 4764 to svn://svn.ffmpeg.org/ffmpeg/trunk
2005-12-22 01:10:11 +00:00
Diego Biurrun
115329f160 COSMETICS: Remove all trailing whitespace.
Originally committed as revision 4749 to svn://svn.ffmpeg.org/ffmpeg/trunk
2005-12-17 18:14:38 +00:00
Fabrice Bellard
e99c4e1037 added ffplay documentation - added automatic man page generation for ffmpeg, ffserver and ffplay
Originally committed as revision 2136 to svn://svn.ffmpeg.org/ffmpeg/trunk
2003-08-24 11:16:29 +00:00