doc: misc improvements for the Windows section
authorDiego Biurrun <diego@biurrun.de>
Thu, 10 May 2012 12:18:10 +0000 (14:18 +0200)
committerDiego Biurrun <diego@biurrun.de>
Mon, 14 May 2012 11:05:39 +0000 (13:05 +0200)
Fix some orthography, wording and grammar issues; update the SDL section
with more current instructions; simplify lib.exe example command line;
drop outdated comments about libnut.

doc/platform.texi

index 97e97c2..c095f52 100644 (file)
@@ -84,7 +84,7 @@ instructions in the download section and the FAQ.
 
 Libav does not build out-of-the-box with the packages the automated MinGW
 installer provides. It also requires coreutils to be installed and many other
 
 Libav does not build out-of-the-box with the packages the automated MinGW
 installer provides. It also requires coreutils to be installed and many other
-packages updated to the latest version. The minimum version for some packages
+packages updated to the latest version. The minimum versions for some packages
 are listed below:
 
 @itemize
 are listed below:
 
 @itemize
@@ -104,17 +104,14 @@ Notes:
 @item Building natively using MSYS can be sped up by disabling implicit rules
 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
 speed up is close to non-existent for normal one-off builds and is only
 @item Building natively using MSYS can be sped up by disabling implicit rules
 in the Makefile by calling @code{make -r} instead of plain @code{make}. This
 speed up is close to non-existent for normal one-off builds and is only
-noticeable when running make for a second time (for example in
+noticeable when running make for a second time (for example during
 @code{make install}).
 
 @item In order to compile AVplay, you must have the MinGW development library
 @code{make install}).
 
 @item In order to compile AVplay, you must have the MinGW development library
-of @uref{http://www.libsdl.org/, SDL}.
-Edit the @file{bin/sdl-config} script so that it points to the correct prefix
-where SDL was installed. Verify that @file{sdl-config} can be launched from
-the MSYS command line.
+of @uref{http://www.libsdl.org/, SDL} and @code{pkg-config} installed.
 
 @item By using @code{./configure --enable-shared} when configuring Libav,
 
 @item By using @code{./configure --enable-shared} when configuring Libav,
-you can build libavutil, libavcodec and libavformat as DLLs.
+you can build all libraries as DLLs.
 
 @end itemize
 
 
 @end itemize
 
@@ -134,7 +131,7 @@ you might have to modify the procedures slightly.
 
 @subsection Using static libraries
 
 
 @subsection Using static libraries
 
-Assuming you have just built and installed Libav in @file{/usr/local}.
+Assuming you have just built and installed Libav in @file{/usr/local}:
 
 @enumerate
 
 
 @enumerate
 
@@ -257,14 +254,11 @@ are stored.
 @item Generate new import libraries with @file{lib.exe}:
 
 @example
 @item Generate new import libraries with @file{lib.exe}:
 
 @example
-lib /machine:i386 /def:..\lib\avcodec-53.def  /out:avcodec.lib
-lib /machine:i386 /def:..\lib\avdevice-53.def /out:avdevice.lib
-lib /machine:i386 /def:..\lib\avfilter-2.def  /out:avfilter.lib
-lib /machine:i386 /def:..\lib\avformat-53.def /out:avformat.lib
-lib /machine:i386 /def:..\lib\avutil-51.def   /out:avutil.lib
-lib /machine:i386 /def:..\lib\swscale-2.def   /out:swscale.lib
+lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
 @end example
 
 @end example
 
+Replace @code{foo-version} and @code{foo} with the respective library names.
+
 @end enumerate
 
 @anchor{Cross compilation for Windows with Linux}
 @end enumerate
 
 @anchor{Cross compilation for Windows with Linux}
@@ -306,8 +300,8 @@ Then run
 
 to make a static build.
 
 
 to make a static build.
 
-The current @code{gcc4-core} package is buggy and needs this flag to build
-shared libraries:
+To build shared libraries add a special compiler flag to work around current
+@code{gcc4-core} package bugs in addition to the normal configure flags:
 
 @example
 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
 
 @example
 ./configure --enable-shared --disable-static --extra-cflags=-fno-reorder-functions
@@ -327,11 +321,8 @@ yasm, libSDL-devel, libfaac-devel, libgsm-devel, libmp3lame-devel,
 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
 @end example
 
 libschroedinger1.0-devel, speex-devel, libtheora-devel, libxvidcore-devel
 @end example
 
-The recommendation for libnut and x264 is to build them from source by
-yourself, as they evolve too quickly for Cygwin Ports to be up to date.
-
-Cygwin 1.7.x has IPv6 support. You can add IPv6 to Cygwin 1.5.x by means
-of the @code{libgetaddrinfo-devel} package, available at Cygwin Ports.
+The recommendation for x264 is to build it from source, as it evolves too
+quickly for Cygwin Ports to be up to date.
 
 @section Crosscompilation for Windows under Cygwin
 
 
 @section Crosscompilation for Windows under Cygwin