FileWriter MaxBackups description is misleading :v

オープン 初心者向け
#109 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
85/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
go
領域
documentation

調査の方向性

issue では、リンク先の行にある file.go の MaxBackups の説明が示されています。そのコメントを file.go#L232 のクリーンアップループとあわせて読み、MaxBackups=0 の動作を確認してください。コードに合うように説明を更新し、ゼロの場合に古いログファイルがすべて保持されるという記述がなくなったことを確認してください。

索引モデルが issue の本文から書いたものです。

説明

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!

主要言語
Go
スター
881
フォーク
64
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

phuslu/log のほかの issue

phuslu/log の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。