zephyrproject-rtos/zephyr

Add documentation for the flash simulator

Open

#20 654 ouverte le 13 nov. 2019

Voir sur GitHub
 (1 commentaire) (0 réactions) (1 assigné)C (15 249 stars) (9 144 forks)batch import
EnhancementGood first issuearea: Documentationarea: Flash

Description

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

Guide contributeur

Stack technique
c
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
C programming basicsKConfig systemZephyr flash subsystem
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.