zephyrproject-rtos/zephyr

Add documentation for the flash simulator

Open

#20.654 geöffnet am 13. Nov. 2019

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)C (15.249 Stars) (9.144 Forks)batch import
EnhancementGood first issuearea: Documentationarea: Flash

Beschreibung

Is your enhancement proposal related to a problem? Please describe.

Currently there is no documentation about how to use the flash simulator

Describe the solution you'd like

Add documentation about how to use the flash simulator, eg. how to specify the flash size, sector size, features supported via KConfig, ...

Describe alternatives you've considered

Browse the code base

Contributor Guide

Tech Stack
c
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
C programming basicsKConfig systemZephyr flash subsystem
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
The issue requests adding documentation for the flash simulator. The contributor should explore the flash simulator implementation in the Zephyr codebase, likely in `subsys/dfu` or `drivers/flash`. Documentation should include examples for configuring flash size, sector size, and features via KConfig. Since the issue is assigned, check with the assignee or maintainers before starting.