[Ffmpeg-devel] [RFC]: vhook Documentation

Piero Bugoni crboca32
Mon Mar 5 02:22:58 CET 2007


I got the copy of texi2html156_natsuki that you sent.
Thanks. Things look better now.

The last section doesn't match the formatting in the
source, and I do not know why. However, this draft of
hooks.texi includes the changes you submitted as well
as those you suggested.

I have included some usage examples in the imlib2
section. I have tested them and they all work.

I included the bit about how imlib2 depends on the
external library imlib2. 

With regard to that, I have a question:

If a person is pointed to an external source for
something, putting an explicit URL to that item is
nice, but unfortunately seems doomed to failure

Also, mentioning a single source may give the
impression that that is the only source. Finally, I do
not know if it is proper to give one party a "plug",
or free advertising, while excluding others.

In the case of imlib2, I used the general language:

"available on Sourceforge, among other places, if it
is not already installed on your system."

This seemed like a decent compromise. What is the
position on this? 

For some usage examples, I explained them in a
paragraph below the example. This may make the
documentation lengthy, but I am not sure if it is
correct to expect someone to understand an example
merely by its command line syntax.

For users of Red Hat based systems, it may be
worthwhile to remind them that this or that may
require the corresponding "-devel" package. Omitting
these is a simple mistake that anyone can make and
mentioning it may save people hours of annoyance.

I mention these things here, since I would like to
continue documentation, and will come across the same
problems elsewhere.


The fish are biting. 
Get more visitors on your site using Yahoo! Search Marketing.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: hooks.texi.diff
Type: application/octet-stream
Size: 7180 bytes
Desc: 801158189-hooks.texi.diff
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070304/31ba4a47/attachment.obj>

More information about the ffmpeg-devel mailing list