Understanding The Basics
To illustrate what makefile does, we first create a project folder (I named it CMakeTuto here).
Then use VSCode to open the folder.
mkdir CMakeTuto
cd CMakeTuto/
code .
Note here makefile do not accept spaces. It only accept tabs.
#include
int main(){
std::cout «Hello World!\n»;
return 0;
}
Now your CMakeTuto directory should be like this:
So what a makefile does?
Use the make command to run the makefile
make command basically run the command in makefile . (that is g++ main.cpp -o out in this case. )
Now a out file should appear. Run the out file.
It should print the “Hello World!”.
The concept of CMake
CMake makes your makefile.
now we can first delete our makefile and out in the previous section.
First check our cmake version
You can also use the command cmake to check the usage.
Common usage: cmake [options]
Create a file CMakeLists.txt , leave the file blank.
Now your directory should be:
Lets create a directory build.
Note if you want to use cmake command, you need to go to the build directory (which is build ).
Now your directory should be like this:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.
├── build
│ ├── CMakeCache.txt
│ ├── CMakeFiles
│ │ ├── 3.10.2
│ │ │ ├── CMakeCCompiler.cmake
│ │ │ ├── CMakeCXXCompiler.cmake
│ │ │ ├── CMakeDetermineCompilerABI_C.bin
│ │ │ ├── CMakeDetermineCompilerABI_CXX.bin
│ │ │ ├── CMakeSystem.cmake
│ │ │ ├── CompilerIdC
│ │ │ │ ├── a.out
│ │ │ │ ├── CMakeCCompilerId.c
│ │ │ │ └── tmp
│ │ │ └── CompilerIdCXX
│ │ │ ├── a.out
│ │ │ ├── CMakeCXXCompilerId.cpp
│ │ │ └── tmp
│ │ ├── cmake.check_cache
│ │ ├── CMakeDirectoryInformation.cmake
│ │ ├── CMakeOutput.log
│ │ ├── CMakeTmp
│ │ ├── feature_tests.bin
│ │ ├── feature_tests.c
│ │ ├── feature_tests.cxx
│ │ ├── Makefile2
│ │ ├── Makefile.cmake
│ │ ├── progress.marks
│ │ └── TargetDirectories.txt
│ ├── cmake_install.cmake
│ └── Makefile
├── CMakeLists.txt
└── main.cpp
8 directories, 24 files
Notice now the Makefile is generated.
If You look into that Makefile and you will see it just build what our CMakeLists.txt require.
(Note we haven’t write anything into CMakeLists.txt yet)
We won’t teach those generated files.
Edit your CMakeLists.txt
Now write into your CMakeLists.txt .
cmake_minimum_required(VERSION 3.9.0)
project(HelloWorld) #replace «HelloWorld» with your project name
add_executable(${PROJECT_NAME} main.cpp)
run the cmake command in your build folder again.
If You look into that Makefile again and you will see it just build what our CMakeLists.txt require.
Lets run the Makefile using make command.
You should see this outcome:
Scanning dependencies of target HelloWorld
[ 50%] Building CXX object CMakeFiles/HelloWorld.dir/main.cpp.o
[100%] Linking CXX executable HelloWorld
[100%] Built target HelloWorld
And now you should see a HelloWorld executable is in the build folder.
Lets run the HelloWorld executable.
Now you know the basics of cmake.
Another Example — Linking more than 1 file
.
├── adder.cpp
├── CMakeLists.txt
└── main.cpp
float add(float a, float b)
{
return a+b;
}
cmake_minimum_required(VERSION 3.9.0)
project(HelloWorld) #replace «HelloWorld» with your project name
add_executable(${PROJECT_NAME} main.cpp adder.cpp) #add the files here
//function prototype
float add(float a, float b);
#include
int main(){
std::cout add(6.9, 13.2)
return 0;
}
Build and run the program
mkdir build
cd build
cmake ..
make
./HelloWorld
Libraries and Subdirectories
Levels and Libraries
In practical situations we often put our files into a folder.
We need to put a sublevel CMakeLists.txt in each subfolder.
.
├── Adder
│ ├── adder.cpp
│ ├── adder.h
│ └── CMakeLists.txt
├── CMakeLists.txt
└── main.cpp
1 directory, 5 files
#include «adder.h»
float add(float a, float b)
{
return a+b;
}
#include
#include «Adder/adder.h»
int main(){
std::cout add(6.9, 13.2)
return 0;
}
cmake_minimum_required(VERSION 3.9.0)
project(HelloWorld) #replace «HelloWorld» with your project name
add_executable(${PROJECT_NAME} main.cpp) #build the main
add_subdirectory(Adder) #build the libraries
target_include_directories(${PROJECT_NAME} PUBLIC Adder)
#—uncomment this if your cmake version >3.13.0
#—target_link_directories(${PROJECT_NAME} PRIVATE Adder)
target_link_libraries(${PROJECT_NAME} adder) #links the libraries to core project
the sublevel Adder/CMakeLists.txt
add_library(adder adder.cpp) #build as a library in the most simplistic way possible
Build and run the program
mkdir build && cd build
cmake ..
make
./HelloWorld
Reference
Makefile для самых маленьких
Не очень строгий перевод материала mrbook.org/tutorials/make Мне в свое время очень не хватило подобной методички для понимания базовых вещей о make. Думаю, будет хоть кому-нибудь интересно. Хотя эта технология и отмирает, но все равно используется в очень многих проектах. Кармы на хаб «Переводы» не хватило, как только появится возможность — добавлю и туда. Добавил в Переводы. Если есть ошибки в оформлении, то прошу указать на них. Буду исправлять.
Статья будет интересная прежде всего изучающим программирование на C/C++ в UNIX-подобных системах от самых корней, без использования IDE.
Компилировать проект ручками — занятие весьма утомительное, особенно когда исходных файлов становится больше одного, и для каждого из них надо каждый раз набивать команды компиляции и линковки. Но не все так плохо. Сейчас мы будем учиться создавать и использовать Мейкфайлы. Makefile — это набор инструкций для программы make, которая помогает собирать программный проект буквально в одно касание.
Для практики понадобится создать микроскопический проект а-ля Hello World из четырех файлов в одном каталоге:
#include #include "functions.h" using namespace std; int main()
#include #include "functions.h" using namespace std; void print_hello()
#include "functions.h" int factorial(int n) < if(n!=1)< return(n * factorial(n-1)); >else return 1; > void print_hello(); int factorial(int n); Все скопом можно скачать отсюда
Автор использовал язык C++, знать который совсем не обязательно, и компилятор g++ из gcc. Любой другой компилятор скорее всего тоже подойдет. Файлы слегка подправлены, чтобы собирались gcc 4.7.1
Программа make
Если запустить
make
то программа попытается найти файл с именем по умолчание Makefile в текущем каталоге и выполнить инструкции из него. Если в текущем каталоге есть несколько мейкфайлов, то можно указать на нужный вот таким образом:
make -f MyMakefile
Есть еще множество других параметров, нам пока не нужных. О них можно узнать в ман-странице.
Процесс сборки
Компилятор берет файлы с исходным кодом и получает из них объектные файлы. Затем линковщик берет объектные файлы и получает из них исполняемый файл. Сборка = компиляция + линковка.
Компиляция руками
Самый простой способ собрать программу:
g++ main.cpp hello.cpp factorial.cpp -o hello
Каждый раз набирать такое неудобно, поэтому будем автоматизировать.
Самый простой Мейкфайл
цель: зависимости [tab] команда all: g++ main.cpp hello.cpp factorial.cpp -o hello Обратите внимание, что строка с командой должна начинаться с табуляции! Сохраните это под именем Makefile-1 в каталоге с проектом и запустите сборку командой make -f Makefile-1
В первом примере цель называется all . Это цель по умолчанию для мейкфайла, которая будет выполняться, если никакая другая цель не указана явно. Также у этой цели в этом примере нет никаких зависимостей, так что make сразу приступает к выполнению нужной команды. А команда в свою очередь запускает компилятор.
Использование зависимостей
Использовать несколько целей в одном мейкфайле полезно для больших проектов. Это связано с тем, что при изменении одного файла не понадобится пересобирать весь проект, а можно будет обойтись пересборкой только измененной части. Пример:
all: hello hello: main.o factorial.o hello.o g++ main.o factorial.o hello.o -o hello main.o: main.cpp g++ -c main.cpp factorial.o: factorial.cpp g++ -c factorial.cpp hello.o: hello.cpp g++ -c hello.cpp clean: rm -rf *.o hello Это надо сохранить под именем Makefile-2 все в том же каталоге
Теперь у цели all есть только зависимость, но нет команды. В этом случае make при вызове последовательно выполнит все указанные в файле зависимости этой цели.
Еще добавилась новая цель clean . Она традиционно используется для быстрой очистки всех результатов сборки проекта. Очистка запускается так: make -f Makefile-2 clean
Использование переменных и комментариев
Переменные широко используются в мейкфайлах. Например, это удобный способ учесть возможность того, что проект будут собирать другим компилятором или с другими опциями.
# Это комментарий, который говорит, что переменная CC указывает компилятор, используемый для сборки CC=g++ #Это еще один комментарий. Он поясняет, что в переменной CFLAGS лежат флаги, которые передаются компилятору CFLAGS=-c -Wall all: hello hello: main.o factorial.o hello.o $(CC) main.o factorial.o hello.o -o hello main.o: main.cpp $(CC) $(CFLAGS) main.cpp factorial.o: factorial.cpp $(CC) $(CFLAGS) factorial.cpp hello.o: hello.cpp $(CC) $(CFLAGS) hello.cpp clean: rm -rf *.o hello Это Makefile-3
Переменные — очень удобная штука. Для их использования надо просто присвоить им значение до момента их использования. После этого можно подставлять их значение в нужное место вот таким способом: $(VAR)
Что делать дальше
После этого краткого инструктажа уже можно пробовать создавать простые мейкфайлы самостоятельно. Дальше надо читать серьезные учебники и руководства. Как финальный аккорд можно попробовать самостоятельно разобрать и осознать такой универсальный мейкфайл, который можно в два касания адаптировать под практически любой проект:
CC=g++ CFLAGS=-c -Wall LDFLAGS= SOURCES=main.cpp hello.cpp factorial.cpp OBJECTS=$(SOURCES:.cpp=.o) EXECUTABLE=hello all: $(SOURCES) $(EXECUTABLE) $(EXECUTABLE): $(OBJECTS) $(CC) $(LDFLAGS) $(OBJECTS) -o $@ .cpp.o: $(CC) $(CFLAGS) $< -o $@ how to run makefile in ubuntu
./hello.exe or ./add.exe works fine. when I type ./all on my friend's pc, it shows proper output.
I've just noticed that you've tagged this as ubuntu but you're compiling .exe programs? My answer still stands but which OS are you using and which OS is your friend using?
2 Answers 2
Your friend's PC is doing something strange and its not clear from your question what they've done. Your PC is acting normally.
Calling make all Will compile everything, but it doesn't actually make a program called all . It only compiles two programs: hello.exe and add.exe .
So calling ./all should fail because that is asking to run a program called all which doesn't exist.
It's quite possible that your friend has written themselves a program or script called "all". You'll need to ask your friend what that script / program does and how it does it.
To see what your friend has done open a terminal on your friends pc (like the one in your screen shot) and type the command
This will list all the files in that directory. Look for one named "all". It might look something like this (with the word "all" in green):
-rwxr----- 1 appy appy 67 Oct 23 15:05 all Assuming that's there you can look at the contents of it by typing
To get yours to work like your friends, create a similar file with the same contents. To make it runnable you may need to change the file permissions: