docs(logging): drop restatement comments, keep upstream cites#4582
Merged
Conversation
…items Removes restating test comments and trims a redundant inline restatement in the repo-prefix helper. Preserves all upstream rsync source references (log.c, options.c, rsync.h) and load-bearing WHY comments such as the ordering note in `target_to_debug_flag` and the verbose-level mappings in `from_verbose_level`. All public items already had rustdoc; no new docs were required.
github-actions
Bot
added
the
documentation
This was referenced May 20, 2026
This was referenced May 20, 2026
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
config.rs,thread_local.rs,phase_timer.rs, andtracing_bridge_tests.rsthat merely echoed the next assertion.error_format.rs::strip_repo_prefixand replaces a vague "Fallback:" note with the actual reason for the alternate branch.init_tracing.// upstream: log.c / options.c / rsync.hcitation and every WHY comment (e.g. the ordering note intarget_to_debug_flag, the per-level upstreaminfo_verbosity[]/debug_verbosity[]mappings infrom_verbose_level, and the "filtering happens at debug_gte" clarification).Net delta: 6 files, +16 / -48.
Test plan
cargo fmt --all -- --checkcargo clippy --workspace --all-targets --all-features --no-deps -- -D warnings