History

doc: Improve references to external URLs.

Sometimes it makes sense to replace a raw URL with some informative text that links to the URL instead of using the raw URL itself in the text. Also transform some mailing list references into links.

Diego Biurrun committed 15 years ago

Commit 2cb6dec1 parent 028216b5 files · +39 −29Browse files

Unified · Split

5 files
  1. doc/developer.texi +22 −14
  2. doc/faq.texi +10 −7
  3. doc/ffmpeg.texi +2 −2
  4. doc/general.texi +4 −5
  5. doc/protocols.texi +1 −1
doc/developer.texi+22−14
@@ -31,14 +31,16 @@ only the public api is used. · 30 unmodified lines
31 31
32You can use Libav in your commercial program, but you must abide to the32You can use Libav in your commercial program, but you must abide to the
33license, LGPL or GPL depending on the specific features used, please refer33license, LGPL or GPL depending on the specific features used, please refer
34to @url{http://libav.org/legal.html} for a quick checklist and to34to @uref{http://libav.org/legal.html, our legal page} for a quick checklist and to
35@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2},35the following links for the exact text of each license:
36@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3},36@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2, GPL version 2},
37@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1},37@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3, GPL version 3},
38@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3} for the38@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1, LGPL version 2.1},
39exact text of the licenses.39@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3, LGPL version 3}.
40Any modification to the source code can be suggested for inclusion.40Any modification to the source code can be suggested for inclusion.
41The best way to proceed is to send your patches to the Libav mailing list.41The best way to proceed is to send your patches to the
42@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
43mailing list.
42 44
43@anchor{Coding Rules}45@anchor{Coding Rules}
44@section Coding Rules46@section Coding Rules
@@ -177,7 +179,10 @@ should also be avoided if they don't make the code easier to understand. · 132 unmodified lines
177 When applying patches that have been discussed (at length) on the mailing179 When applying patches that have been discussed (at length) on the mailing
178 list, reference the thread in the log message.180 list, reference the thread in the log message.
179@item181@item
180 Subscribe to the libav-devel and libav-commits mailing list.182 Subscribe to the
183 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and
184 @uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits}
185 mailing lists.
181 Bugs and possible improvements or general questions regarding commits186 Bugs and possible improvements or general questions regarding commits
182 are discussed on libav-devel. We expect you to react if problems with187 are discussed on libav-devel. We expect you to react if problems with
183 your code are uncovered.188 your code are uncovered.
@@ -241,8 +246,9 @@ it does not cause unexpected problems. · 57 unmodified lines
241 246
242Patches should be posted as base64 encoded attachments (or any other247Patches should be posted as base64 encoded attachments (or any other
243encoding which ensures that the patch will not be trashed during248encoding which ensures that the patch will not be trashed during
244transmission) to the libav-devel mailing list, see249transmission) to the
245@url{https://lists.libav.org/mailman/listinfo/libav-devel}250@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
251mailing list.
246 252
247It also helps quite a bit if you tell us what the patch does (for example253It also helps quite a bit if you tell us what the patch does (for example
248'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant254'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
@@ -314,9 +320,9 @@ send a reminder by email. Your patch should eventually be dealt with. · 65 unmodified lines
314@item320@item
315 Is the patch against latest Libav git master branch?321 Is the patch against latest Libav git master branch?
316@item322@item
317 Are you subscribed to libav-devel?323 Are you subscribed to the
318 (@url{https://lists.libav.org/mailman/listinfo/libav-devel}324 @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
319 the list is subscribers)325 mailing list? (Only list subscribers are allowed to post.)
320@item326@item
321 Have you checked that the changes are minimal, so that the same cannot be327 Have you checked that the changes are minimal, so that the same cannot be
322 achieved with a smaller patch and/or simpler final code?328 achieved with a smaller patch and/or simpler final code?
@@ -370,7 +376,9 @@ send a reminder by email. Your patch should eventually be dealt with. · 47 unmodified lines
370 376
371@section Patch review process377@section Patch review process
372 378
373All patches posted to libav-devel will be reviewed, unless they contain a379All patches posted to the
380@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
381mailing list will be reviewed, unless they contain a
374clear note that the patch is not for the git master branch.382clear note that the patch is not for the git master branch.
375Reviews and comments will be posted as replies to the patch on the383Reviews and comments will be posted as replies to the patch on the
376mailing list. The patch submitter then has to take care of every comment,384mailing list. The patch submitter then has to take care of every comment,
doc/faq.texi+10−7
@@ -24,8 +24,8 @@ help out creating them. · 23 unmodified lines
24Nowhere. We do not support old Libav versions in any way, we simply lack24Nowhere. We do not support old Libav versions in any way, we simply lack
25the time, motivation and manpower to do so. If you have a problem with an25the time, motivation and manpower to do so. If you have a problem with an
26old version of Libav, upgrade to the latest git snapshot. If you26old version of Libav, upgrade to the latest git snapshot. If you
27still experience the problem, then you can report it according to the27still experience the problem, then you can report it according to our
28guidelines in @url{http://libav.org/bugreports.html}.28@uref{http://libav.org/bugreports.html, bug reporting guidelines}.
29 29
30@section Why doesn't Libav support feature [xyz]?30@section Why doesn't Libav support feature [xyz]?
31 31
@@ -46,7 +46,8 @@ Likely reasons · 14 unmodified lines
46@itemize46@itemize
47@item We are busy and haven't had time yet to read your report or47@item We are busy and haven't had time yet to read your report or
48investigate the issue.48investigate the issue.
49@item You didn't follow @url{http://libav.org/bugreports.html}.49@item You did not follow our
50 @uref{http://libav.org/bugreports.html, bug reporting guidelines}.
50@item You didn't use git master.51@item You didn't use git master.
51@item You reported a segmentation fault without gdb output.52@item You reported a segmentation fault without gdb output.
52@item You describe a problem but not how to reproduce it.53@item You describe a problem but not how to reproduce it.
@@ -123,8 +124,9 @@ problem and an NP-hard problem... · 70 unmodified lines
123 124
124@section ffmpeg does not work; what is wrong?125@section ffmpeg does not work; what is wrong?
125 126
126Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see127Try a @code{make distclean} in the ffmpeg source directory before the build.
127(@url{http://libav.org/bugreports.html}).128If this does not help see our
129@uref{http://libav.org/bugreports.html, bug reporting guidelines}.
128 130
129@section How do I encode single pictures into movies?131@section How do I encode single pictures into movies?
130 132
@@ -285,7 +287,8 @@ Just create an "input.avs" text file with this single line ... · 154 unmodified lines
285 ffmpeg -i input.avs287 ffmpeg -i input.avs
286@end example288@end example
287 289
288For ANY other help on Avisynth, please visit @url{http://www.avisynth.org/}.290For ANY other help on Avisynth, please visit the
291@uref{http://www.avisynth.org/, Avisynth homepage}.
289 292
290@section How can I join video files?293@section How can I join video files?
291 294
@@ -413,7 +416,7 @@ No. These tools are too bloated and they complicate the build. · 121 unmodified lines
413Libav is already organized in a highly modular manner and does not need to416Libav is already organized in a highly modular manner and does not need to
414be rewritten in a formal object language. Further, many of the developers417be rewritten in a formal object language. Further, many of the developers
415favor straight C; it works for them. For more arguments on this matter,418favor straight C; it works for them. For more arguments on this matter,
416read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).419read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
417 420
418@section I do not like the LGPL, can I contribute code under the GPL instead?421@section I do not like the LGPL, can I contribute code under the GPL instead?
419 422
doc/ffmpeg.texi+2−2
@@ -882,8 +882,8 @@ ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg · 881 unmodified lines
882@end example882@end example
883 883
884Note that you must activate the right video source and channel before884Note that you must activate the right video source and channel before
885launching ffmpeg with any TV viewer such as xawtv885launching ffmpeg with any TV viewer such as
886(@url{http://linux.bytesex.org/xawtv/}) by Gerd Knorr. You also886@uref{http://linux.bytesex.org/xawtv/, xawtv} by Gerd Knorr. You also
887have to set the audio recording levels correctly with a887have to set the audio recording levels correctly with a
888standard mixer.888standard mixer.
889 889
doc/general.texi+4−5
@@ -836,7 +836,7 @@ noticeable when running make for a second time (for example in · 835 unmodified lines
836@code{make install}).836@code{make install}).
837 837
838@item In order to compile FFplay, you must have the MinGW development library838@item In order to compile FFplay, you must have the MinGW development library
839of SDL. Get it from @url{http://www.libsdl.org}.839of @uref{http://www.libsdl.org/, SDL}.
840Edit the @file{bin/sdl-config} script so that it points to the correct prefix840Edit the @file{bin/sdl-config} script so that it points to the correct prefix
841where SDL was installed. Verify that @file{sdl-config} can be launched from841where SDL was installed. Verify that @file{sdl-config} can be launched from
842the MSYS command line.842the MSYS command line.
@@ -1008,8 +1008,7 @@ Then configure Libav with the following options: · 165 unmodified lines
1008(you can change the cross-prefix according to the prefix chosen for the1008(you can change the cross-prefix according to the prefix chosen for the
1009MinGW tools).1009MinGW tools).
1010 1010
1011Then you can easily test Libav with Wine1011Then you can easily test Libav with @uref{http://www.winehq.com/, Wine}.
1012(@url{http://www.winehq.com/}).
1013 1012
1014@subsection Compilation under Cygwin1013@subsection Compilation under Cygwin
1015 1014
@@ -1048,8 +1047,8 @@ If you want to build Libav with additional libraries, download Cygwin · 32 unmodified lines
1048libogg-devel, libvorbis-devel1047libogg-devel, libvorbis-devel
1049@end example1048@end example
1050 1049
1051These library packages are only available from Cygwin Ports1050These library packages are only available from
1052(@url{http://sourceware.org/cygwinports/}) :1051@uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
1053 1052
1054@example1053@example
1055yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel,1054yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel,
doc/protocols.texi+1−1
@@ -242,7 +242,7 @@ data transferred over RDT). · 241 unmodified lines
242 242
243The muxer can be used to send a stream using RTSP ANNOUNCE to a server243The muxer can be used to send a stream using RTSP ANNOUNCE to a server
244supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's244supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
245RTSP server, @url{http://github.com/revmischa/rtsp-server}).245@uref{http://github.com/revmischa/rtsp-server, RTSP server}).
246 246
247The required syntax for a RTSP url is:247The required syntax for a RTSP url is:
248@example248@example

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t