Document the 19 undocumented configuration attributes

Abierto Apto para principiantes
#438 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rust

Línea de trabajo

Compara los comentarios de configuración de src/lib.rs líneas 385–468 con docs/src/config/common-options.md. Lee las secciones existentes sobre las opciones y, después, documenta los 19 atributos enumerados e indica el tiempo de espera predeterminado. La tarea estará terminada cuando common-options.md cubra cada opción enumerada y el tiempo de espera predeterminado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Where

Problem
Not mentioned anywhere in docs/README/examples: debug_log_libafl, shutdown_on_stop_without_reason, quit_on_iteration_limit, save_{timeout,solution,interesting,all}_execution_traces, execution_trace_directory, execution_trace_pc_only, heartbeat, heartbeat_interval, symbolic_coverage, symbolic_coverage_system, symbolic_coverage_directory, debuginfo_download_directory, debuginfo_source_directory, debug_info, last_exception_processor_number, last_stop_reason. The default timeout is not stated.

Impact
Source coverage and execution tracing have no user documentation.

Suggested fix
Add sections to common-options.md from the lib.rs doc comments.

Related
#65

Status
Reported by static code review at 79972db; not yet re-verified line by line. Found by reading the code; not reproduced under SIMICS.

Lenguaje dominante
Rust
Estrellas
335
Forks
26
Merge medio
1 d 50 min
PR fusionados (30 d)
12

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de intel/tsffs

Todos los issues de intel/tsffs

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.