zephyrproject-rtos/zephyr

Add documentation for the flash simulator

Open

#20,654 opened on Nov 13, 2019

View on GitHub
 (1 comment) (0 reactions) (1 assignee)C (9,144 forks)batch import
EnhancementGood first issuearea: Documentationarea: Flash

Repository metrics

Stars
 (15,249 stars)
PR merge metrics
 (Avg merge 4d 21h) (1,000 merged PRs in 30d)

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

Contributor guide

Research direction
Review the flash simulator source code and Kconfig options to document how to configure and use it.
Tech stack
c
Domain
embedded iotoperating systems
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80