From 0a010ca406f84e4bd5ba5b931b392bbc3c1ac6d5 Mon Sep 17 00:00:00 2001 From: cournape Date: Wed, 3 Sep 2008 08:33:08 +0000 Subject: [PATCH] Document CheckCC and co in the man. git-svn-id: http://scons.tigris.org/svn/scons/trunk@3336 fdb21ef1-2011-0410-befe-b5e4ea1792b1 --- doc/man/scons.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/doc/man/scons.1 b/doc/man/scons.1 index 399024ab..b0dd1e89 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -6859,6 +6859,50 @@ or and selects the compiler to be used for the check; the default is "C". +.TP +.RI Configure.CheckCC( self ) +Checks whether the C compiler (as defined by the CC construction variable) works +by trying to compile a small source file. + +By default, SCons only detects if there is a program with the correct name, not +if it is a functioning compiler. + +This uses the exact same command than the one used by the object builder for C +source file, so it can be used to detect if a particular compiler flag works or +not. + +.TP +.RI Configure.CheckCXX( self ) +Checks whether the C++ compiler (as defined by the CXX construction variable) +works by trying to compile a small source file. By default, SCons only detects +if there is a program with the correct name, not if it is a functioning compiler. + +This uses the exact same command than the one used by the object builder for +CXX source files, so it can be used to detect if a particular compiler flag +works or not. + +.TP +.RI Configure.CheckSHCC( self ) +Checks whether the C compiler (as defined by the SHCC construction variable) works +by trying to compile a small source file. By default, SCons only detects if +there is a program with the correct name, not if it is a functioning compiler. + +This uses the exact same command than the one used by the object builder for C +source file, so it can be used to detect if a particular compiler flag works or +not. This does not check whether the object code can be used to build a shared +library, only that the compilation (not link) succeeds. + +.TP +.RI Configure.CheckSHCXX( self ) +Checks whether the C++ compiler (as defined by the SHCXX construction variable) +works by trying to compile a small source file. By default, SCons only detects +if there is a program with the correct name, not if it is a functioning compiler. + +This uses the exact same command than the one used by the object builder for +CXX source files, so it can be used to detect if a particular compiler flag +works or not. This does not check whether the object code can be used to build +a shared library, only that the compilation (not link) succeeds. + .EE Example of a typical Configure usage: -- 2.26.2