Commit Graph

35 Commits

Author SHA1 Message Date
Michael Niedermayer 4d13d440ee Merge commit '94f084324e648876508bed546d950762f10b875e'
* commit '94f084324e648876508bed546d950762f10b875e':
  texi2pod: Make it output a single encoding string

Conflicts:
	doc/texi2pod.pl

See: 12ce58bebd
Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-09-03 12:24:47 +02:00
Luca Barbato 94f084324e texi2pod: Make it output a single encoding string
Intermixing =encoding utf-8 in the file can confuse some pod2man
implementations.
2014-09-03 02:14:17 +02:00
Michael Niedermayer 8f23045b16 Merge commit 'be59675add2a05a7400b1abf86201ab069d7b1dd'
* commit 'be59675add2a05a7400b1abf86201ab069d7b1dd':
  doc: Change the multitable rendering in texi2pod

Conflicts:
	doc/texi2pod.pl

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-04-09 04:26:20 +02:00
Luca Barbato be59675add doc: Change the multitable rendering in texi2pod
Makes it working better for our documentation purposes.
2014-04-08 23:24:42 +02:00
Michael Niedermayer 12ce58bebd doc/texi2pod: fix encoding type
docs say:
'A document having more than one "=encoding" line should be considered an error. '

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-03-13 03:54:48 +01:00
Michael Niedermayer a8ad7e47fb Merge remote-tracking branch 'qatar/master'
* qatar/master:
  texi2pod: always declare the pod file as UTF-8 encoded

Conflicts:
	doc/texi2pod.pl

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-25 09:02:57 +01:00
Janne Grunau 5ea14d48a8 texi2pod: always declare the pod file as UTF-8 encoded 2014-02-24 23:36:09 +01:00
Timothy Gu 474db7a696 doc/texi2pod: make references bold
Inspired by GCC r86635.

This is more consistent with other man pages. For example in `man git`,
all the "git-help(1)" kind of cross refs are bold.

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-06 16:18:26 +01:00
Michael Niedermayer 003f405caf Merge remote-tracking branch 'qatar/master'
* qatar/master:
  doc: Try to find nonstandard Perl path from the environment

Conflicts:
	doc/texi2pod.pl

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-12-01 21:50:13 +01:00
Diego Biurrun 7b05845b15 doc: Try to find nonstandard Perl path from the environment 2013-12-01 12:59:10 -05:00
Stefano Sabatini c838701ce4 doc/texi2pod.pl: skip printing chapter names if they are disabled 2013-03-30 16:58:45 +01:00
Stefano Sabatini 9167db3829 doc/texi2pod: fix @ref substitution rule, disallow "}" within the fields
Fix potential spurious substitution.
2013-03-07 01:44:59 +01:00
Stefano Sabatini c0c06c1bba doc/texi2pod: fix warnings introduced in e7e14bc69a
The variable "$section" was replaced by "$chapter".
2013-01-26 15:12:57 +01:00
Michael Niedermayer e7e14bc69a Merge commit '38c1466ca41c73c7ce347da702362cb69c151716'
* commit '38c1466ca41c73c7ce347da702362cb69c151716':
  dict: add av_dict_parse_string()
  doc: support multitable in texi2pod

Conflicts:
	doc/APIchanges
	libavutil/version.h

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-01-26 13:34:30 +01:00
Luca Barbato 5ea5ffc9ce doc: support multitable in texi2pod 2013-01-25 14:03:05 +01:00
Stefano Sabatini c499d45c6b doc/texipod: add rule to correctly interpret @ref{ANCHOR,XREF,SECTION_NAME,...}
This allows to name an internal reference in the POD/MAN output.
2013-01-13 15:09:08 +01:00
Stefano Sabatini ca3d786227 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.
2012-12-19 09:33:04 +01:00
Stefano Sabatini 1f9855dbc1 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.
2012-12-18 00:06:35 +01:00
Stefano Sabatini f14e248783 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.
2012-12-17 23:54:07 +01:00
Nicolas George ee2d6fbc92 doc/texi2pod: recognize @table @command. 2012-11-17 19:47:56 +01:00
Stefano Sabatini ce875a613a 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.
2012-10-24 23:33:47 +02:00
Stefano Sabatini 3239382aef 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>
2012-08-12 23:52:55 +02: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