chipsalliance/chisel

We have no documentation/training on `Mem`

Aperta

#2324 aperta il 3 gen 2022

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Scala (651 fork)batch import
good first issue

Metriche repository

Star
 (4658 stelle)
Metriche merge PR
 (Merge medio 3g 21h) (16 PR mergiate in 30 g)

Descrizione

Type of issue: documentation

Impact: no functional change

Development Phase: request

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

We don't have any documentation that I can find on Mem in the Chisel bootcamp, or the website explanations docs or cookbooks. We only cover SyncReadMem.

What is the current behavior?

What is the expected behavior?

We should probably at least mention this in the explanations section

Please tell us about your environment:

What is the use case for changing the behavior?

Not having undocumented features

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente per SyncReadMem nel bootcamp di Chisel, nelle sezioni esplicative del sito web e nei cookbook. Identifica dove dovrebbe essere menzionato Mem (ad esempio, insieme a SyncReadMem nelle primitive di memoria). Crea una piccola sezione che descriva il comportamento e l'uso di Mem, simile alla documentazione di SyncReadMem. Aggiorna i file markdown pertinenti nel repository.
Tech stack
scala
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90