docs: добавь поясняющие комментарии к модулям и инструментам
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
# Сборка библиотеки flash_storage. Состав исходников и публичные include-пути задают
|
||||
# подключение к проекту потребителя. Файл также собирает и регистрирует хостовые проверки;
|
||||
# запускать их следует через CTest из каталога сборки.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13)
|
||||
project(flash_storage C)
|
||||
add_library(flash_storage STATIC Src/flash_storage.c)
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Переносимое хранение записей во Flash с распознаванием версии формата и маркера завершённой
|
||||
* записи. Разделение полезных данных и commit-маркера позволяет отличать завершённую запись от
|
||||
* оборванной при потере питания.
|
||||
*/
|
||||
|
||||
#ifndef PORTABLE_FLASH_STORAGE_H
|
||||
#define PORTABLE_FLASH_STORAGE_H
|
||||
#include <stddef.h>
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация flash-storage. Макросы задают параметры сборки и ограничения, используемые
|
||||
* исходниками этого модуля. Смысл и единицы каждого параметра определяются местом его
|
||||
* использования; размеры буферов должны быть согласованы у всех потребителей заголовка.
|
||||
*/
|
||||
|
||||
#ifndef PORTABLE_FLASH_STORAGE_CONFIG_H
|
||||
#define PORTABLE_FLASH_STORAGE_CONFIG_H
|
||||
#define FLASH_STORAGE_MAGIC 0x474E4952UL
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Переносимое хранение записей во Flash с распознаванием версии формата и маркера завершённой
|
||||
* записи. Разделение полезных данных и commit-маркера позволяет отличать завершённую запись от
|
||||
* оборванной при потере питания.
|
||||
*/
|
||||
|
||||
#include "flash_storage.h"
|
||||
#include "flash_storage_config.h"
|
||||
#include <stddef.h>
|
||||
|
||||
@@ -1,3 +1,13 @@
|
||||
/*
|
||||
* Проверки flash_storage: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Сценарии для навигации по файлу:
|
||||
* test_ds
|
||||
* test_flash
|
||||
* test_instances
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "ds18b20.h"
|
||||
#include "flash_storage.h"
|
||||
#include <assert.h>
|
||||
|
||||
Reference in New Issue
Block a user