From 2570dfb4d937d6100b59c30d50fab2ec5ab0f6cd Mon Sep 17 00:00:00 2001 From: "Adam J. Stewart" Date: Fri, 20 Oct 2017 19:31:12 -0500 Subject: Update Getting Started docs to clarify that full Xcode suite is required for qt (#4958) * Update Getting Started docs to clarify that full Xcode suite is required for qt * Better error message when only the command-line tools are installed --- lib/spack/docs/getting_started.rst | 60 ++++++++++++++++++++++++++++++++++---- lib/spack/spack/compilers/clang.py | 25 ++++++++++++++++ 2 files changed, 79 insertions(+), 6 deletions(-) diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst index ffa9bf2414..0c35162f1e 100644 --- a/lib/spack/docs/getting_started.rst +++ b/lib/spack/docs/getting_started.rst @@ -411,14 +411,62 @@ provides no Fortran compilers. The user is therefore forced to use a mixed toolchain: XCode-provided Clang for C/C++ and GNU ``gfortran`` for Fortran. -#. You need to make sure that command-line tools are installed. To that - end run ``$ xcode-select --install``. +#. You need to make sure that Xcode is installed. Run the following command: -#. Run ``$ spack compiler find`` to locate Clang. + .. code-block:: console + + $ xcode-select --install + + + If the Xcode command-line tools are already installed, you will see an + error message: + + .. code-block:: none + + xcode-select: error: command line tools are already installed, use "Software Update" to install updates + + +#. For most packages, the Xcode command-line tools are sufficient. However, + some packages like ``qt`` require the full Xcode suite. You can check + to see which you have installed by running: + + .. code-block:: console + + $ xcode-select -p + + + If the output is: + + .. code-block:: none + + /Applications/Xcode.app/Contents/Developer + + + you already have the full Xcode suite installed. If the output is: + + .. code-block:: none + + /Library/Developer/CommandLineTools + + + you only have the command-line tools installed. The full Xcode suite can + be installed through the App Store. Make sure you launch the Xcode + application and accept the license agreement before using Spack. + It may ask you to install additional components. Alternatively, the license + can be accepted through the command line: + + .. code-block:: console + + $ sudo xcodebuild -license accept + + + Note: the flag is ``-license``, not ``--license``. + +#. Run ``spack compiler find`` to locate Clang. #. There are different ways to get ``gfortran`` on macOS. For example, you can - install GCC with Spack (``$ spack install gcc``) or with Homebrew - (``$ brew install gcc``). + install GCC with Spack (``spack install gcc``) or with Homebrew + (``brew install gcc``). #. The only thing left to do is to edit ``~/.spack/compilers.yaml`` to provide the path to ``gfortran``: @@ -434,7 +482,7 @@ Fortran. fc: /path/to/bin/gfortran If you used Spack to install GCC, you can get the installation prefix by - ``$ spack location -i gcc`` (this will only work if you have a single version + ``spack location -i gcc`` (this will only work if you have a single version of GCC installed). Whereas for Homebrew, GCC is installed in ``/usr/local/Cellar/gcc/x.y.z``. diff --git a/lib/spack/spack/compilers/clang.py b/lib/spack/spack/compilers/clang.py index eea4798798..b4caad7484 100644 --- a/lib/spack/spack/compilers/clang.py +++ b/lib/spack/spack/compilers/clang.py @@ -202,7 +202,32 @@ class Clang(Compiler): return xcode_select = Executable('xcode-select') + + # Get the path of the active developer directory real_root = xcode_select('--print-path', output=str).strip() + + # The path name can be used to determine whether the full Xcode suite + # or just the command-line tools are installed + if real_root.endswith('Developer'): + # The full Xcode suite is installed + pass + else: + if real_root.endswith('CommandLineTools'): + # Only the command-line tools are installed + msg = 'It appears that you have the Xcode command-line tools ' + msg += 'but not the full Xcode suite installed.\n' + + else: + # Xcode is not installed + msg = 'It appears that you do not have Xcode installed.\n' + + msg += 'In order to use Spack to build the requested application, ' + msg += 'you need the full Xcode suite. It can be installed ' + msg += 'through the App Store. Make sure you launch the ' + msg += 'application and accept the license agreement.\n' + + raise OSError(msg) + real_root = os.path.dirname(os.path.dirname(real_root)) developer_root = os.path.join(spack.stage_path, 'xcode-select', -- cgit v1.2.3-70-g09d2