Skip to content

Commit 174be54

Browse files
committed
dd first-time tip, to warn against doing "make".
now i think we're reasonably safe.
1 parent d338db4 commit 174be54

File tree

2 files changed

+30
-24
lines changed

2 files changed

+30
-24
lines changed

CMakeLists.txt

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -141,22 +141,28 @@ ei_testing_print_summary()
141141
message("")
142142
message("Configured Eigen ${EIGEN_VERSION_NUMBER}")
143143
message("You can now do the following:")
144-
message("-------------+-----------------------------------------------------------------")
145-
message("Command | Description")
146-
message("-------------+-----------------------------------------------------------------")
147-
message("make install | Install to ${CMAKE_INSTALL_PREFIX}")
148-
message(" | To change that, do: cmake . -DCMAKE_INSTALL_PREFIX=yourpath")
149-
message("make | Build the unit tests")
150-
message(" | Note: that's NOT needed if you just want to install Eigen!")
151-
message(" | Note: this takes lots of time & memory! Easy on the -j option!")
152-
message("make test | Build and run the unit tests (using CTest)")
153-
message("make test_qr | Build a specific test, here test_qr. To run it: test/test_qr")
154-
message("make debug_qr| Build a test with full debug info. To run it: test/debug_qr")
155-
message("make blas | Build BLAS library")
156-
message("make doc | Generate the API documentation, requires Doxygen & LaTeX")
157-
message("-------------+-----------------------------------------------------------------")
158-
message("")
159-
message("There's no need to do 'make' unless you really want to build the unit tests!")
160-
message("")
161-
162-
144+
message("--------------+----------------------------------------------------------------")
145+
message("Command | Description")
146+
message("--------------+----------------------------------------------------------------")
147+
message("make install | Install to ${CMAKE_INSTALL_PREFIX}")
148+
message(" | To change that: cmake . -DCMAKE_INSTALL_PREFIX=yourpath")
149+
message("make | Build the unit tests")
150+
message(" | * That's not needed if you just want to install Eigen!")
151+
message(" | * That takes lots of memory! Easy on the -j option!")
152+
message("make test | Build and run the unit tests (using CTest)")
153+
message("make test_qr | Build a specific test, here test_qr. To run it: test/test_qr")
154+
message("make debug_qr | Build a test with full debug info. To run it: test/debug_qr")
155+
message("make blas | Build BLAS library (not the same thing as Eigen)")
156+
message("make doc | Generate the API documentation, requires Doxygen & LaTeX")
157+
message("--------------+----------------------------------------------------------------")
158+
159+
if(NOT EIGEN_CMAKE_ALREADY_RUN)
160+
unset(EIGEN_CMAKE_ALREADY_RUN CACHE) # in case it was manually set to OFF in cache
161+
set(EIGEN_CMAKE_ALREADY_RUN "ON" CACHE BOOL "Set to ON if CMake has already run here.")
162+
message("")
163+
message("First-time tip:")
164+
message("")
165+
message("If you just want to install Eigen, do 'make install' right away.")
166+
message("No need to do 'make' before. See INSTALL file for more details.")
167+
message("")
168+
endif(NOT EIGEN_CMAKE_ALREADY_RUN)

INSTALL

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Installation instructions for Eigen
44
Explanation before starting
55
***************************
66

7-
It is very important to understand than Eigen consists only of header files,
7+
It is very important to understand that Eigen consists only of header files,
88
hence there is nothing to compile before you can use it. Moreover, these
99
header files do not depend on your platform, they are the same for
1010
everybody.
@@ -15,14 +15,14 @@ Method 1. Installing without using CMake
1515

1616
You can use right away the headers in the Eigen/ subdirectory. In order
1717
to install, just copy this Eigen/ subdirectory to your favorite location.
18-
If you also want the unsupported features, also copy the unsupported/
19-
subdirectory.
18+
If you also want the unsupported features, copy the unsupported/
19+
subdirectory too.
2020

2121
Method 2. Installing using CMake
2222
********************************
2323

24-
Let's call this directory 'source_dir'. Before starting, create another
25-
directory which we will call 'build_dir'.
24+
Let's call this directory 'source_dir' (where this INSTALL file is).
25+
Before starting, create another directory which we will call 'build_dir'.
2626

2727
Do:
2828

0 commit comments

Comments
 (0)