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
3131
3232 You can use Libav in your commercial program, but you must abide to the
3333 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}.
4040 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.
4244
4345 @anchor{Coding Rules}
4446 @section Coding Rules
@@ -177,7 +179,10 @@ should also be avoided if they don't make the code easier to understand. · 132 unmodified lines
177179 When applying patches that have been discussed (at length) on the mailing
178180 list, reference the thread in the log message.
179181 @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.
181186 Bugs and possible improvements or general questions regarding commits
182187 are discussed on libav-devel. We expect you to react if problems with
183188 your code are uncovered.
@@ -241,8 +246,9 @@ it does not cause unexpected problems. · 57 unmodified lines
241246
242247 Patches should be posted as base64 encoded attachments (or any other
243248 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}
249+transmission) to the
250+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
251+mailing list.
246252
247253 It also helps quite a bit if you tell us what the patch does (for example
248254 '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
314320 @item
315321 Is the patch against latest Libav git master branch?
316322 @item
317− Are you subscribed to libav-devel?
318− (@url{https://lists.libav.org/mailman/listinfo/libav-devel}
319− the list is subscribers)
323+ Are you subscribed to the
324+ @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
325+ mailing list? (Only list subscribers are allowed to post.)
320326 @item
321327 Have you checked that the changes are minimal, so that the same cannot be
322328 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
370376
371377 @section Patch review process
372378
373−All patches posted to libav-devel will be reviewed, unless they contain a
379+All patches posted to the
380+@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel}
381+mailing list will be reviewed, unless they contain a
374382 clear note that the patch is not for the git master branch.
375383 Reviews and comments will be posted as replies to the patch on the
376384 mailing 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
2424 Nowhere. We do not support old Libav versions in any way, we simply lack
2525 the time, motivation and manpower to do so. If you have a problem with an
2626 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}.
2929
3030 @section Why doesn't Libav support feature [xyz]?
3131
@@ -46,7 +46,8 @@ Likely reasons · 14 unmodified lines
4646 @itemize
4747 @item We are busy and haven't had time yet to read your report or
4848 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}.
5051 @item You didn't use git master.
5152 @item You reported a segmentation fault without gdb output.
5253 @item You describe a problem but not how to reproduce it.
@@ -123,8 +124,9 @@ problem and an NP-hard problem... · 70 unmodified lines
123124
124125 @section ffmpeg does not work; what is wrong?
125126
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}).
127+Try a @code{make distclean} in the ffmpeg source directory before the build.
128+If this does not help see our
129+@uref{http://libav.org/bugreports.html, bug reporting guidelines}.
128130
129131 @section How do I encode single pictures into movies?
130132
@@ -285,7 +287,8 @@ Just create an "input.avs" text file with this single line ... · 154 unmodified lines
285287 ffmpeg -i input.avs
286288 @end example
287289
288−For ANY other help on Avisynth, please visit @url{http://www.avisynth.org/}.
290+For ANY other help on Avisynth, please visit the
291+@uref{http://www.avisynth.org/, Avisynth homepage}.
289292
290293 @section How can I join video files?
291294
@@ -413,7 +416,7 @@ No. These tools are too bloated and they complicate the build. · 121 unmodified lines
413416 Libav is already organized in a highly modular manner and does not need to
414417 be rewritten in a formal object language. Further, many of the developers
415418 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}).
419+read @uref{http://www.tux.org/lkml/#s15, "Programming Religion"}.
417420
418421 @section I do not like the LGPL, can I contribute code under the GPL instead?
419422
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
882882 @end example
883883
884884 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
887887 have to set the audio recording levels correctly with a
888888 standard mixer.
889889
doc/general.texi+4−5
@@ -836,7 +836,7 @@ noticeable when running make for a second time (for example in · 835 unmodified lines
836836 @code{make install}).
837837
838838 @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}.
840840 Edit the @file{bin/sdl-config} script so that it points to the correct prefix
841841 where SDL was installed. Verify that @file{sdl-config} can be launched from
842842 the MSYS command line.
@@ -1008,8 +1008,7 @@ Then configure Libav with the following options: · 165 unmodified lines
10081008 (you can change the cross-prefix according to the prefix chosen for the
10091009 MinGW tools).
10101010
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}.
10131012
10141013 @subsection Compilation under Cygwin
10151014
@@ -1048,8 +1047,8 @@ If you want to build Libav with additional libraries, download Cygwin · 32 unmodified lines
10481047 libogg-devel, libvorbis-devel
10491048 @end example
10501049
1051−These library packages are only available from Cygwin Ports
1052−(@url{http://sourceware.org/cygwinports/}) :
1050+These library packages are only available from
1051+@uref{http://sourceware.org/cygwinports/, Cygwin Ports}:
10531052
10541053 @example
10551054 yasm, libSDL-devel, libdirac-devel, libfaac-devel, libgsm-devel,
doc/protocols.texi+1−1
@@ -242,7 +242,7 @@ data transferred over RDT). · 241 unmodified lines
242242
243243 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
244244 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}).
246246
247247 The required syntax for a RTSP url is:
248248 @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