Makefile – это файл, в котором содержатся инструкции, необходимые для автоматизации процесса сборки программного проекта. Он является неотъемлемой частью системы управления проектами GNU Make и позволяет эффективно обрабатывать зависимости между исходными файлами, объектными файлами и исполняемым файлом.
Основная задача makefile – обновление только тех файлов, которые изменились, исходя из их зависимостей. В результате сборки обычно получается исполняемый файл, но makefile может включать и другие команды, например, для компиляции исходного кода или копирования файлов.
В основе makefile лежит простая структура – правила. Каждое правило состоит из:
- Цели – это то, что хотим получить в результате выполнения правила.
- Зависимости – это файлы, от которых зависит цель.
- Команды – это команды, которые необходимо выполнить для получения цели.
Makefile может содержать несколько правил, и выполнение каждого правила состоит в том, чтобы проверить, изменились ли файлы-зависимости, и если да, то выполнить команды для получения цели. Если файлы не изменились, то выполнение правила пропускается.
В данной статье мы рассмотрим основные правила и команды, которые позволят вам написать эффективный makefile для вашего проекта.
Определение и назначение makefile
Главная задача makefile — автоматизация процесса сборки приложения. Он позволяет определить зависимости между файлами и команды, которые необходимо выполнить для обновления или сборки проекта.
Makefile состоит из набора правил, каждое из которых определяет зависимости между файлами и команды для их обработки. Когда вызывается команда make, она проверяет время модификации файлов и определяет, какие из них требуют обновления. Затем makefile выполняет команды, указанные в правилах, чтобы обновить или собрать требуемые файлы.
Основное назначение makefile — облегчить и автоматизировать процесс разработки программного проекта. Он позволяет разработчикам легко отслеживать зависимости и изменения в проекте, а также автоматически выполнять задачи сборки или обновления.
Makefile является одним из основных инструментов во многих проектах с открытым исходным кодом, таких как ядро Linux или библиотека GNU. Он обеспечивает четкую структуру и простоту управления проектом.
Основные правила
Для создания makefile существуют несколько принятых правил, которые необходимо учитывать:
- Makefile должен иметь название «Makefile» (без расширения), чтобы утилита make могла его автоматически обнаружить.
- Makefile должен содержать правило по умолчанию (обычно называемое «all»), которое определяет цели, которые будут выполнены по умолчанию при вызове make без указания конкретной цели.
- Правила в makefile выполняются последовательно, в порядке их описания. Если какое-то правило зависит от других правил, они должны быть расположены выше в файле.
- Каждое правило в makefile начинается с цели — имени файла или директории, которую нужно создать или обновить.
- После имени цели следует двоеточие («:»).
- После двоеточия следуют список зависимостей цели — файлов или других целей, от которых зависит текущая цель.
- После списка зависимостей можно указать команды, которые должны быть выполнены для создания или обновления цели. Команды должны начинаться с табуляции.
- Комментарии в makefile начинаются с символа «#», остаток строки после символа игнорируется.
Соблюдение этих правил позволит создавать структурированные и понятные makefile, которые легко поддерживать и модифицировать.
Определение целей и зависимостей
Makefile предоставляет нам возможность определить несколько целей, которые могут быть выполнены с помощью команды make. Цели могут представлять собой различные задачи, которые мы хотим выполнить, например компиляцию программы или создание архива.
Для определения целей в makefile используется следующий синтаксис:
цель: зависимости
[команда]
Цель — это задача, которую мы хотим выполнить. Зависимости — это файлы или другие цели, от которых зависит выполнение текущей цели. Команда — это команда, которая будет выполнена, если все зависимости были изменены или отсутствуют.
Пример:
program: main.o functions.o
gcc main.o functions.o -o program
В данном примере мы определяем цель program, которая зависит от файлов main.o и functions.o. Команда gcc main.o functions.o -o program будет выполнена, если файлы main.o и functions.o были изменены или отсутствуют.
Зависимости могут иметь свои зависимости, создавая иерархическую структуру целей. Таким образом, мы можем определить последовательность задач, которые должны быть выполнены по порядку.
Пример:
all: clean program
clean:
rm -f *.o
rm -f program
program: main.o functions.o
gcc main.o functions.o -o program
В данном примере мы определяем цель all, которая зависит от целей clean и program. При выполнении цели all, сначала будет выполнена цель clean, которая удалит все файлы с расширением .o и файл program, а затем будет выполнена цель program, которая скомпилирует программу.
Определение целей и зависимостей в makefile позволяет нам логически структурировать наши задачи и контролировать их выполнение.
Определение команд и переменных
Makefile позволяет определять команды и переменные, которые будут использоваться в процессе сборки проекта.
Команды в Makefile представляют собой последовательности действий, которые необходимо выполнить для достижения определенной цели. Каждая команда начинается с табуляции и может быть выполнена в командной оболочке, такой как Bash.
Переменные в Makefile позволяют определить значения, которые могут быть использованы в командах и других местах файлов. Они обычно используются для хранения путей к файлам, настроек компилятора или других параметров, которые могут изменяться в зависимости от среды выполнения.
Определение команд осуществляется с помощью следующей конструкции:
target: dependencies
[TAB]command1
[TAB]command2
...
где:
- target — цель, для которой определяется команда. Цель может быть файлом, который необходимо создать или обновить, или командой, которую нужно выполнить.
- dependencies — список зависимостей для цели. Зависимости могут быть файлами или другими целями, которые должны быть выполнены перед выполнением команды.
- command1, command2, … — команды, которые необходимо выполнить для достижения цели. Каждая команда должна начинаться с табуляции.
Определение переменных осуществляется с помощью следующей конструкции:
VARIABLE = value
где:
- VARIABLE — имя переменной.
- value — значение, которое будет назначено переменной.
Переменные в Makefile могут использоваться с помощью символа «$». Например, чтобы получить значение переменной «VARIABLE», можно использовать запись «$(VARIABLE)».
Команды для написания makefile
Makefile представляет собой файл, который описывает, как компилировать и собирать проекты. Он содержит набор правил и команд для автоматизации процесса сборки программного обеспечения. В этом разделе мы рассмотрим основные команды, используемые при написании makefile.
- target: dependencies
command – описание цели, зависимостей и команд, которые нужно выполнить для достижения этой цели. Например, all: main.o functions.o
gcc -o program main.o functions.o. - .PHONY: target – указывает на то, что цель является фиктивной (phony) и не соответствует реальному файлу. Такое правило запустится всегда, независимо от наличия файла с таким именем.
- clean – команда для удаления временных файлов, созданных в процессе компиляции. Часто используется для очистки проекта перед новой сборкой. Например, clean:
rm -f *.o program. - .SUFFIXES: .ext1 .ext2 – задает список допустимых расширений для файлов. Используется вместе с переменной $(MAKEFILE_LIST), чтобы определить список файлов, которые нужно обрабатывать.
- export variable – экспорт переменной из текущей makefile во все следующие makefile, которые будут обработаны.
- \@\textless – макрос, который можно использовать в командах, чтобы указать имя текущей цели. Например, clean:
rm -f \@\textless. - $(wildcard pattern) – функция, которая возвращает список файлов, соответствующих заданному шаблону.
- $(patsubst pattern, replacement, text) – функция, которая заменяет все вхождения шаблона в строке на заданный текст и возвращает новую строку.
Команды в makefile выполняются последовательно построчно. Использование переменных, условных операторов и циклов позволяет создавать более сложные правила и автоматизировать процесс сборки проектов.
all
Когда мы запускаем команду make без аргументов, она ищет первую цель в файле makefile. Если эта цель называется all, то выполняются все цели, определенные после нее.
Часто цель all используется для сборки всего проекта. Здесь мы можем указать команды, которые собирают все компоненты программы и преобразуют их в готовый продукт. Это может включать в себя сборку и компиляцию исходных файлов, линковку объектных файлов, создание исполняемых файлов и другие операции.
Цель all часто используется вместе с другими целями, которые отвечают за сборку отдельных компонентов проекта. Например, мы можем иметь отдельные цели для сборки библиотеки, исполняемого файла и тестового набора. В таком случае, команда all будет запускать все эти цели в определенном порядке.
Использование цели all в makefile позволяет нам легко управлять процессом сборки и иметь полный контроль над тем, какие компоненты проекта должны быть собраны.
clean
Чтобы определить правило clean в makefile, необходимо указать цель для этого правила, за которой следует команда для очистки файлов:
clean:
rm -f *.o program
Вышеуказанное правило clean удаляет все файлы с расширением .o (файлы объектов) и файл с именем program, который представляет исполняемый файл программы.
Чтобы выполнить команду clean, необходимо ввести следующую команду в командной строке:
make clean
После выполнения команды make clean все файлы, указанные в правиле clean, будут удалены из текущего каталога.
install
Команда install в makefile используется для установки собранных файлов в заданное место. Она позволяет копировать файлы, создавать директории и устанавливать разрешения прав доступа.
Синтаксис команды:
install: [пререквизиты]
команда
где:
[пререквизиты]— файлы или директории, которые нужно установить;команда— команда, которая будет выполнять установку.
Пример:
install: app
cp app /usr/local/bin
chmod 755 /usr/local/bin/app
В данном примере, файл app будет скопирован в директорию /usr/local/bin и будет установлено разрешение на выполнение.
Кроме того, команда install может использоваться для создания директорий и установки разрешений на доступ. Например:
install:
mkdir -p /etc/myapp
cp config.ini /etc/myapp
chmod 644 /etc/myapp/config.ini
В этом примере, будет создана директория /etc/myapp, файл config.ini будет скопирован в эту директорию и будет установлено разрешение на чтение для всех пользователей.
uninstall
Команда uninstall в makefile используется для удаления установленного программного обеспечения или файлов, созданных при выполнении других команд. Эта команда особенно полезна, когда вам нужно удалить предыдущую версию программы перед установкой новой.
Чтобы использовать команду uninstall, вам необходимо определить цель с именем uninstall в своем makefile и указать шаги, которые нужно выполнить для удаления установленных файлов.
Вот пример простого makefile с целью uninstall:
uninstall:
rm -rf /usr/local/bin/myprogram
rm -rf /usr/local/share/man/man1/myprogram.1
rm -rf /usr/local/share/doc/myprogram
rm -rf /usr/local/lib/myprogram
В этом примере цель uninstall использует команду rm -rf для удаления файлов и директорий, связанных с программой myprogram, которая была установлена в системе.
Чтобы выполнить команду uninstall, просто запустите make uninstall в командной строке.
Важно отметить, что команда uninstall не является стандартной командой в makefile и должна быть явно определена в файле, чтобы быть доступной для использования.