Browse code

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