Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

ringbuf: consider renaming `GEN` column to something less confusable

Abierto
  • ¿Algo no está bien?
#478 1 comentario 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
rust
Área
cli

Línea de trabajo

Comienza con el comando humility ringbuf y localiza dónde se formatean su encabezado de columna y el contexto de generación de tareas. Revisa las alternativas propuestas para LAP, CYCLE y la generación de tareas, y confirma después que la redacción elegida funciona tanto para volcados con varias tareas como para volcados con una sola tarea; se considera terminado cuando la salida no es ambigua.

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

Descripción

Currently, humility ringbuf's output has the following column names:

 NDX LINE      GEN    COUNT PAYLOAD

The GEN column the generation number of the ringbuf slot. However, this is confuse-able with the task's generation, which may give the user the incorrect impression that a task has been restarted a bunch of times.

We may want to consider changing the name of this column to something that doesn't introduce the possibility for such confusion. I suggested LAP (as in "lap around the ring buffer"), which is also three characters. @lzrd suggested CYCLE (and note that the column is always at least 8 characters long, so we definitely have space for CYCLE).

Alternatively, we could maybe have the humility ringbuf command also show the actual generation of the task in the header? This way, although we would refer to "gen" twice, it would be clearer which is the task generation versus the ringbuf entry, like this:

humility: ring buffer ksz8463::__RINGBUF in net (gen 0):
 NDX LINE      GEN    COUNT PAYLOAD
   3  140     6544        1 Read(IADR4, 0x2a5e)
   4  140     6544        1 Read(P2MBSR, 0x7808)
   5  140     6544        1 Read(P2MBCR, 0x3120)
...

That would require humility ringbuf to inspect the task table, which wouldn't work in single-task dumps (but we could just not display it in single task dumps).

I'm very open to any other naming suggestions or other thoughts for how to make this clearer, as well.

Lenguaje dominante
Rust
Estrellas
589
Forks
66
Merge medio
2 d 52 min
PR fusionados (30 d)
10

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 oxidecomputer/humility

Todos los issues de oxidecomputer/humility

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.