docs: добавь поясняющие комментарии к модулям и инструментам

c/firmware-info/CMakeLists.txt

@@ -1,3 +1,7 @@
+# Сборка библиотеки firmware_info. Состав исходников и публичные include-пути задают
+# подключение к проекту потребителя. Файл также собирает и регистрирует хостовые проверки;
+# запускать их следует через CTest из каталога сборки.
+
 cmake_minimum_required(VERSION 3.16)
 project(firmware_info C)
 add_library(firmware_info src/firmware_info.c)

c/firmware-info/include/firmware_info.h

@@ -1,3 +1,9 @@
+/*
+ * Представление версии работающей прошивки, даты сборки и идентификатора исходников. Данные
+ * переводятся в формат, доступный потребителям библиотеки; build ID описывает сборку и не
+ * заменяет контрольную сумму образа.
+ */
+
 #ifndef FIRMWARE_INFO_H
 #define FIRMWARE_INFO_H
 

c/firmware-info/include/firmware_info_port.h

@@ -1,3 +1,9 @@
+/*
+ * Заполнение описания прошивки из макросов конфигурации конкретного MCU-проекта. Заголовок
+ * firmware_info_config.h выбирается путями включения; общая библиотека не должна содержать
+ * версию чужого приложения.
+ */
+
 #ifndef FIRMWARE_INFO_PORT_H
 #define FIRMWARE_INFO_PORT_H
 

c/firmware-info/ports/k1921vk028/firmware_info_config.template.h

@@ -1,3 +1,9 @@
+/*
+ * Конфигурация firmware-info для порта k1921vk028. Макросы задают параметры сборки и
+ * ограничения, используемые исходниками этого модуля. Это образец для проекта: значения
+ * выводов, размеров памяти и параметров устройства необходимо согласовать с целевой платой.
+ */
+
 #ifndef FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_VERSION_MAJOR 1U

c/firmware-info/ports/stm32f1/firmware_info_config.template.h

@@ -1,3 +1,9 @@
+/*
+ * Конфигурация firmware-info для порта stm32f1. Макросы задают параметры сборки и ограничения,
+ * используемые исходниками этого модуля. Это образец для проекта: значения выводов, размеров
+ * памяти и параметров устройства необходимо согласовать с целевой платой.
+ */
+
 #ifndef FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_VERSION_MAJOR 1U

c/firmware-info/ports/stm32f4/firmware_info_config.template.h

@@ -1,3 +1,9 @@
+/*
+ * Конфигурация firmware-info для порта stm32f4. Макросы задают параметры сборки и ограничения,
+ * используемые исходниками этого модуля. Это образец для проекта: значения выводов, размеров
+ * памяти и параметров устройства необходимо согласовать с целевой платой.
+ */
+
 #ifndef FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_VERSION_MAJOR 1U

c/firmware-info/ports/stm32g4/firmware_info_config.template.h

@@ -1,3 +1,9 @@
+/*
+ * Конфигурация firmware-info для порта stm32g4. Макросы задают параметры сборки и ограничения,
+ * используемые исходниками этого модуля. Это образец для проекта: значения выводов, размеров
+ * памяти и параметров устройства необходимо согласовать с целевой платой.
+ */
+
 #ifndef FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_INFO_CONFIG_H
 #define FIRMWARE_VERSION_MAJOR 1U

c/firmware-info/src/firmware_info.c

@@ -1,3 +1,9 @@
+/*
+ * Представление версии работающей прошивки, даты сборки и идентификатора исходников. Данные
+ * переводятся в формат, доступный потребителям библиотеки; build ID описывает сборку и не
+ * заменяет контрольную сумму образа.
+ */
+
 #include "firmware_info.h"
 
 static const char months[12][4] = {

c/firmware-info/src/firmware_info_port.c

@@ -1,3 +1,9 @@
+/*
+ * Заполнение описания прошивки из макросов конфигурации конкретного MCU-проекта. Заголовок
+ * firmware_info_config.h выбирается путями включения; общая библиотека не должна содержать
+ * версию чужого приложения.
+ */
+
 #include "firmware_info_port.h"
 
 firmware_info_status_t firmware_info_port_describe(firmware_info_t *info)

c/firmware-info/tests/test_firmware_info.c

@@ -1,3 +1,9 @@
+/*
+ * Проверки firmware_info: фиксируют ожидаемое поведение на воспроизводимых входных данных.
+ * Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
+ * настройками рабочего устройства.
+ */
+
 #include "firmware_info.h"
 #include <assert.h>
 #include <string.h>

c/firmware-info/tools/make_build_id.ps1

@@ -1,3 +1,7 @@
+# Создание firmware_build_id.h из идентификатора Git для включения в прошивку. При отсутствии
+# Git используется предусмотренное скриптом резервное значение; выходной файл содержит
+# метаданные сборки, а не исходный код протокола.
+
 param(
     [string]$Repository = (Resolve-Path (Join-Path $PSScriptRoot '..\..\..\..\..')).Path,
     [string]$Output = (Join-Path $PSScriptRoot '..\generated\firmware_build_id.h')