FileWriter MaxBackups description is misleading :v

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
go

Línea de trabajo

El issue señala la descripción de MaxBackups en file.go, en las líneas enlazadas. Lee ese comentario junto con el bucle de limpieza en file.go#L232 para confirmar el comportamiento de MaxBackups=0. Actualiza la descripción para que coincida con el código y luego verifica que ya no afirme que cero conserva todos los archivos de registro antiguos.

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

Descripción

Heyho,

Awesome lib! Just found a bit of a feature description mismatch.

The FileWriter claims that MaxBackups=0 keeps all old log files, but the code never had this option implemented, setting the value to 0 actually removes everything but the newest.

Checked out the history, and that was always the behavior. And I think allowing an infinitely growing log trail is more dangerous than not. So, my only recommendation would be to update phrasing as it seems like that everyone was using it with some value until now.

Relevant source snippet

if w.Cleaner != nil {
	w.Cleaner(w.Filename, w.MaxBackups, matches)
} else {
	for i := 0; i < len(matches)-w.MaxBackups-1; i++ {
		os.Remove(filepath.Join(dir, matches[i].Name()))
	}
}

Oh, and thanks for the hard work, and have a wonderful day!

Lenguaje dominante
Go
Estrellas
881
Forks
64
Métricas de merge de PR
Sin PR fusionados en 30 d

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 phuslu/log

Todos los issues de phuslu/log

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.