Examples and harnessing docs use APIs that no longer exist
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 74/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- rust
- Ambito
- documentation, testing
Direzione di ricerca
Start by comparing the named examples and documentation snippets with the current APIs and constants in src/interfaces/fuzz.rs and the harness headers. Review the listed locations in examples/manual-example/fuzz.simics, docs/src/harnessing/, docs/src/tutorials/kernel-module/running-the-fuzzer.md, docs/src/config/common-options.md, and harness/README.md. Update stale names, values, and snippets; done when the examples match the current APIs and initialize the documented size values correctly.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Where
- https://github.com/intel/tsffs/blob/79972db9c63eba3ac8a1ce348264eee2005b2b16/examples/manual-example/fuzz.simics#L17 (
set_generate_random_corpus), https://github.com/intel/tsffs/blob/79972db9c63eba3ac8a1ce348264eee2005b2b16/examples/manual-example/fuzz.simics#L34 (start_with_maximum_size, 3 args) docs/src/harnessing/closed-box.md:62,70(fuzz.start(...),start_with_maximum_size; says two APIs, there are four)docs/src/tutorials/kernel-module/running-the-fuzzer.md:83-84(magic_start/magic_stop)docs/src/harnessing/compiled-in.md:78,89,197(HARNESS_STOP is magic 4 not 2;HARNESS_STOP_INDEX;size_t *size_ptr)harness/README.md:9-11; header doc examples leavesizeuninitialiseddocs/src/config/common-options.md:101,333(broken snippets)src/interfaces/fuzz.rs:66,154doc comments mentionstart_with_max_size
Problem
Docs and the manual example refer to removed names and wrong magic numbers.
Impact
Users copying the examples get errors or silently wrong harnesses.
Suggested fix
Rename to start_with_buffer_ptr_size_ptr / _size_value / _size_ptr_value, generate_random_corpus, magic_start_index/magic_stop_indices; fix the snippets.
Related
#65
Status
Confirmed for the manual example; the rest reported by static review. Found by reading the code; not reproduced under SIMICS.
- Lingua principale
- Rust
- Stelle
- 335
- Fork
- 26
- Merge medio
- 1g 50m
- PR unite (30g)
- 12
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di intel/tsffs
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
bug UI
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
wardian-app/Wardian#1746 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
jlcodes99/cockpit-tools#3125 ·
I maintainer di solito rispondono entro 2 giorni
-
bug user-sprint
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
Vondor/KassenSturz#967 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
area:build bug effort:low P5 source:agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 1 giorno