From 74eaecfc3e049e96dd30ecadc1d62fb235d3caba Mon Sep 17 00:00:00 2001 From: Ken Martin Date: Thu, 15 Dec 2005 14:17:43 -0500 Subject: ENH: cleanups --- Modules/FindSDL_sound.cmake | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) (limited to 'Modules/FindSDL_sound.cmake') diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake index 025d634c63..be9f54c761 100644 --- a/Modules/FindSDL_sound.cmake +++ b/Modules/FindSDL_sound.cmake @@ -1,7 +1,7 @@ # - Locates the SDL_sound library # This module depends on SDL being found and # must be called AFTER FindSDL.cmake is called. - +# # This module defines # SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h # SDL_SOUND_FOUND, if false, do not try to link to SDL @@ -24,29 +24,31 @@ # FLAC_LIBRARY # SPEEX_LIBRARY # -# Typically, you should not use these variables directly, and you should use -# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries -# (if needed) to successfully compile on your system . +# Typically, you should not use these variables directly, and you should use +# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio +# libraries (if needed) to successfully compile on your system . # # Created by Eric Wing. -# This module is a bit more complicated than the other FindSDL* family modules. -# The reason is that SDL_sound can be compiled in a large variety of different ways -# which are independent of platform. SDL_sound may dynamically link against other 3rd -# party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug, -# MikMod, FLAC, Speex, and potentially others. -# Under some circumstances which I don't fully understand, -# there seems to be a requirement -# that dependent libraries of libraries you use must also be explicitly -# linked against in order to successfully compile. SDL_sound does not currently -# have any system in place to know how it was compiled. -# So this CMake module does the hard work in trying to discover which 3rd party -# libraries are required for building (if any). -# This module uses a brute force approach to create a test program that uses SDL_sound, -# and then tries to build it. If the build fails, it parses the error output for -# known symbol names to figure out which libraries are needed. # -# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would -# correspond to the ./configure --prefix=$SDLDIR used in building SDL. +# This module is a bit more complicated than the other FindSDL* family +# modules. The reason is that SDL_sound can be compiled in a large variety +# of different ways which are independent of platform. SDL_sound may +# dynamically link against other 3rd party libraries to get additional codec +# support, such as Ogg Vorbis, SMPEG, ModPlug, MikMod, FLAC, Speex, and +# potentially others. Under some circumstances which I don't fully +# understand, there seems to be a requirement that dependent libraries of +# libraries you use must also be explicitly linked against in order to +# successfully compile. SDL_sound does not currently have any system in place +# to know how it was compiled. So this CMake module does the hard work in +# trying to discover which 3rd party libraries are required for building (if +# any). +# +# This module uses a brute force approach to create a test program that uses +# SDL_sound, and then tries to build it. If the build fails, it parses the +# error output for known symbol names to figure out which libraries are +# needed. Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable +# that would correspond to the ./configure --prefix=$SDLDIR used in building +# SDL. # # On OSX, this will prefer the Framework version (if found) over others. # People will have to manually change the cache values of -- cgit v1.2.1