diff options
author | Diego Biurrun <diego@biurrun.de> | 2011-07-08 15:33:17 +0200 |
---|---|---|
committer | Diego Biurrun <diego@biurrun.de> | 2011-07-12 23:42:20 +0200 |
commit | 2cb6dec61c8e6676105de628ba20a5b3d162976e (patch) | |
tree | 83075ae2227f233ccea56bc1a046768a601a7cfd /doc/developer.texi | |
parent | 028216b2c2d81f7fe918163c74b0a59cd327f2f7 (diff) | |
download | ffmpeg-streaming-2cb6dec61c8e6676105de628ba20a5b3d162976e.zip ffmpeg-streaming-2cb6dec61c8e6676105de628ba20a5b3d162976e.tar.gz |
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.
Diffstat (limited to 'doc/developer.texi')
-rw-r--r-- | doc/developer.texi | 36 |
1 files changed, 22 insertions, 14 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index 597ce95..45a4f44 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -31,14 +31,16 @@ only the public api is used. You can use Libav in your commercial program, but you must abide to the license, LGPL or GPL depending on the specific features used, please refer -to @url{http://libav.org/legal.html} for a quick checklist and to -@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2}, -@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3}, -@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1}, -@url{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3} for the -exact text of the licenses. +to @uref{http://libav.org/legal.html, our legal page} for a quick checklist and to +the following links for the exact text of each license: +@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv2, GPL version 2}, +@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.GPLv3, GPL version 3}, +@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv2.1, LGPL version 2.1}, +@uref{http://git.libav.org/?p=libav.git;a=blob;f=COPYING.LGPLv3, LGPL version 3}. Any modification to the source code can be suggested for inclusion. -The best way to proceed is to send your patches to the Libav mailing list. +The best way to proceed is to send your patches to the +@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} +mailing list. @anchor{Coding Rules} @section Coding Rules @@ -177,7 +179,10 @@ should also be avoided if they don't make the code easier to understand. When applying patches that have been discussed (at length) on the mailing list, reference the thread in the log message. @item - Subscribe to the libav-devel and libav-commits mailing list. + Subscribe to the + @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} and + @uref{https://lists.libav.org/mailman/listinfo/libav-commits, libav-commits} + mailing lists. Bugs and possible improvements or general questions regarding commits are discussed on libav-devel. We expect you to react if problems with your code are uncovered. @@ -241,8 +246,9 @@ it does not cause unexpected problems. Patches should be posted as base64 encoded attachments (or any other encoding which ensures that the patch will not be trashed during -transmission) to the libav-devel mailing list, see -@url{https://lists.libav.org/mailman/listinfo/libav-devel} +transmission) to the +@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} +mailing list. It also helps quite a bit if you tell us what the patch does (for example '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. @item Is the patch against latest Libav git master branch? @item - Are you subscribed to libav-devel? - (@url{https://lists.libav.org/mailman/listinfo/libav-devel} - the list is subscribers) + Are you subscribed to the + @uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} + mailing list? (Only list subscribers are allowed to post.) @item Have you checked that the changes are minimal, so that the same cannot be 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. @section Patch review process -All patches posted to libav-devel will be reviewed, unless they contain a +All patches posted to the +@uref{https://lists.libav.org/mailman/listinfo/libav-devel, libav-devel} +mailing list will be reviewed, unless they contain a clear note that the patch is not for the git master branch. Reviews and comments will be posted as replies to the patch on the mailing list. The patch submitter then has to take care of every comment, |