← Back to team overview

kicad-developers team mailing list archive

Re: PATCH: Tidy up documentation of CMake options

 

When looking at this, I noticed some duplicate text (comments) in
CMakeLists.txt, attached is a patch.

2014-02-23 0:19 GMT+01:00 Wayne Stambaugh <stambaughw@xxxxxxxxxxx>:
> On 2/22/2014 3:35 PM, Blair Bonnett wrote:
>> Hi all,
>>
>> In a recent thread, it was pointed out that the documentation of the
>> CMake configuration options had not been updated to reflect the change
>> from OFF to ON for the default of KICAD_KEEPCASE. There were also an
>> obsolete option (USE_FP_LIB_TABLE) and some undocumented options
>> (BUILD_GITHUB_PLUGIN, KICAD_REPO_NAME, DOWNLOAD_DIR).
>>
>> The attached patch (generated against revision 4713) tidies up
>> Documentation/compiling/build-config.txt. As well as fixing the above
>> oversights, I have add extra whitespace to make it more readable, and
>> made the default settings more prominent.
>>
>> It also fixes a minor spelling mistake in CMakeLists.txt (specifig =>
>> specific) and points the user to the build option documentation from
>> other documentation files.
>>
>> I *think* I got all the default settings correct, but a second pair of
>> eyes would be appreciated.
>>
>> Thanks
>> Blair
>
> Patch committed in r4714.  Thank you for the help.
>
> Regards,
>
> Wayne
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-02-22 23:17:36 +0000
+++ CMakeLists.txt	2014-02-23 02:01:43 +0000
@@ -68,8 +68,6 @@
 
 # WARNING: KiCad developers strongly advise you to build Boost with supplied patches,
 # as it is known to work with KiCad.  Other versions may contain bugs that may result
-# WARNING: KiCad developers strongly advise you to build Boost with supplied patches,
-# as it is known to work with KiCad.  Other versions may contain bugs that may result
 # in KiCad errors.
 option( KICAD_SKIP_BOOST
     "Skip building downloaded Boost library components, use Boost from your system."


Follow ups

References