docs: добавь поясняющие комментарии к модулям и инструментам
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
# Сборка библиотеки settings_backup. Состав исходников и публичные include-пути задают
|
||||
# подключение к проекту потребителя. Файл также собирает и регистрирует хостовые проверки;
|
||||
# запускать их следует через CTest из каталога сборки.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13)
|
||||
project(settings_backup C)
|
||||
add_library(settings_backup STATIC Src/settings_backup.c)
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Автомат создания и восстановления резервных копий настроек. Формат и политика повторов
|
||||
* отделены от файловой системы; ошибки ввода-вывода не должны превращать неполную копию в
|
||||
* подтверждённое состояние.
|
||||
*/
|
||||
|
||||
#ifndef SETTINGS_BACKUP_H
|
||||
#define SETTINGS_BACKUP_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Конфигурация settings-backup. Макросы задают параметры сборки и ограничения, используемые
|
||||
* исходниками этого модуля. Смысл и единицы каждого параметра определяются местом его
|
||||
* использования; размеры буферов должны быть согласованы у всех потребителей заголовка.
|
||||
*/
|
||||
|
||||
#ifndef SETTINGS_BACKUP_CONFIG_H
|
||||
#define SETTINGS_BACKUP_CONFIG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Автомат создания и восстановления резервных копий настроек. Формат и политика повторов
|
||||
* отделены от файловой системы; ошибки ввода-вывода не должны превращать неполную копию в
|
||||
* подтверждённое состояние.
|
||||
*/
|
||||
|
||||
#include "../Inc/settings_backup.h"
|
||||
#include "../Inc/settings_backup_config.h"
|
||||
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
/*
|
||||
* Проверки settings_backup: фиксируют ожидаемое поведение на воспроизводимых входных данных.
|
||||
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
* настройками рабочего устройства.
|
||||
*/
|
||||
|
||||
#include "settings_backup.h"
|
||||
#include <assert.h>
|
||||
#include <string.h>
|
||||
|
||||
@@ -1,3 +1,18 @@
|
||||
# Проверки settings_backup_model: фиксируют ожидаемое поведение на воспроизводимых входных
|
||||
# данных.
|
||||
# Сценарии для навигации по файлу:
|
||||
# test_calendar_tree_and_fat_safe_english_month
|
||||
# test_json_schema_contains_all_32_rooms_full_rom_and_units
|
||||
# test_hash_excludes_rtc_and_prevents_restart_duplicate
|
||||
# test_confirmed_revision_change_creates_copy_not_periodic_tick
|
||||
# test_collision_survives_restart_and_checks_temp_too
|
||||
# test_atomic_failures_preserve_last_good
|
||||
# test_absent_removed_or_full_card_is_non_destructive
|
||||
# test_invalid_rtc_uses_revision_and_never_fake_date
|
||||
# Остальные сценарии продолжают эти проверки ниже в том же файле.
|
||||
# Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
|
||||
# настройками рабочего устройства.
|
||||
|
||||
"""Модельные проверки полного контракта JSON backup без реальной SD-карты."""
|
||||
|
||||
import json
|
||||
|
||||
Reference in New Issue
Block a user