Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#478 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
rust
Lĩnh vực
cli

Hướng nghiên cứu

Bắt đầu với lệnh humility ringbuf và xác định nơi định dạng tiêu đề cột cùng ngữ cảnh tạo tác vụ. Xem xét các phương án được đề xuất cho LAP, CYCLE và việc tạo tác vụ, sau đó xác nhận rằng cách diễn đạt được chọn hoạt động cho cả các dump có nhiều tác vụ lẫn dump có một tác vụ; hoàn tất khi đầu ra không còn mơ hồ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Rust
Star
587
Fork
64
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của oxidecomputer/humility

Tất cả issue của oxidecomputer/humility

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.