Fix cosmetic typos - #683
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR focuses on correcting spelling and wording in comments and user-facing option descriptions across the tar/tarsnap codebase and documentation.
Changes:
- Fix typos in comments (e.g., “commitable”, “differrent”, “simular”).
- Improve clarity/correctness of option descriptions for
--progress-bytes. - Correct spelling in release notes (“occured” → “occurred”).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tar/tarsnap_opt.h | Normalizes wording/capitalization in a network-limit comment. |
| tar/multitape/multitape_transaction.c | Fixes spelling in checkpoint commit-marker comment. |
| tar/bsdtar_windows.c | Fixes multiple comment typos and improves phrasing for Windows/POSIX behavior notes. |
| misc/zsh_completion/_tarsnap | Fixes repeated typo in --progress-bytes completion descriptions. |
| misc/describe-options.txt | Fixes typo in --progress-bytes description. |
| NEWS.md | Fixes typo in release note text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| extern int tarsnap_opt_noisy_warnings; | ||
|
|
||
| /* Maximum number of bytes to send over the network before QUITing. */ | ||
| /* Maximum number of bytes to send over the network before quitting. */ |
| } | ||
|
|
||
| /* Windows' mbstowcs is differrent error handling from other unix mbstowcs. | ||
| /* Windows' mbstowcs has different error handling from other Unix mbstowcs. |
| "--null[input split by NULs instead of newlines]" | ||
| "--null-input[input split by NULs instead of newlines]" | ||
| "--passphrase[read passphrase from ARG, not \/dev\/tty]:method\:arg:" | ||
| "--progress-bytes[print a progress messsage each X bytes]:X:" |
There was a problem hiding this comment.
_tarsnap is automatically generated by shtab; please do not include it in this commit. The change to misc/describe-options.txt is sufficient.
| return (0); | ||
| } | ||
|
|
||
| /* Windows' mbstowcs is differrent error handling from other unix mbstowcs. |
There was a problem hiding this comment.
This file is part of libarchive; please do not make spelling fixes to it, because we don't want to add more diffs from upstream.
| extern int tarsnap_opt_noisy_warnings; | ||
|
|
||
| /* Maximum number of bytes to send over the network before QUITing. */ | ||
| /* Maximum number of bytes to send over the network before sending QUIT. */ |
There was a problem hiding this comment.
A fully grammatical change would be "before sending SIGQUIT to ourselves", but that would exceed one line.
Maybe just make this "before SIGQUIT."?
|
Fixed in #731. |
Summary
misc/describe-options.txtfor--progress-bytes.Fixes #684.
Tests
codespell NEWS.md misc/describe-options.txt misc/zsh_completion/_tarsnap tar/bsdtar_windows.c tar/tarsnap_opt.h tar/multitape/multitape_transaction.cgit diff --check