Add --debug flag to cksum #9088
Open
+116
−0
Conversation
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
Implements the --debug flag for the cksum utility. This flag indicates which implementation is being used for the checksum calculation. Changes: - Add DEBUG constant to options module - Add --debug argument to CLI with help text - Add help text translations (en-US and fr-FR) - Add comprehensive tests for --debug flag with various scenarios The flag is currently a no-op but provides the foundation for future implementation of debug output functionality.
CodSpeed Performance ReportMerging #9088 will not alter performanceComparing Summary
|
|
GNU testsuite comparison: |
cakebaker
reviewed
Oct 30, 2025
Address maintainer feedback to make it clear to users that the --debug flag is a placeholder and does not currently produce any output. Changes: - Update en-US help text to include '(not yet implemented)' - Update fr-FR help text to include '(pas encore implémenté)' This follows the pattern used by other utilities (cp, mkdir, split) for indicating unimplemented features in help text.
|
@cakebaker Updated! ✅ Added the clarification to the help text as requested: English: French: This follows the same pattern used by other utilities in the codebase (cp, mkdir, split) for indicating unimplemented features. The test still passes: |
|
GNU testsuite comparison: |
|
Why not implementing it? |
Fully implement the --debug flag for cksum utility to display which hash algorithm is being used for each file processed. Changes: - Add debug field to Options struct - Create print_debug_info() function to output algorithm information - Integrate debug output into checksum processing flow - Update localization strings (en-US and fr-FR) for debug messages - Remove '(not yet implemented)' disclaimer from help text - Add comprehensive test coverage for debug flag with various algorithms The implementation outputs debug information to stderr (matching GNU cksum behavior) in the format: 'filename: ALGORITHM' or 'standard input: ALGORITHM' for stdin. Tests verify debug output works correctly with: - Default CRC algorithm - MD5, SHA1, SHA256, BLAKE2b algorithms - Single files, multiple files, and stdin input - Custom BLAKE2b lengths All 135 cksum tests pass with no clippy warnings.
|
GNU testsuite comparison: |
cakebaker
reviewed
Oct 31, 2025
There was a problem hiding this comment.
It looks like you implemented something else, but not the --debug functionality from GNU cksum :|
Here is the output I get on my machine when I manually run the first three tests with GNU cksum 9.8:
$ cksum --debug README.md
cksum: avx512 support not detected
cksum: avx2 support not detected
cksum: using pclmul hardware support
3970598914 9068 README.md
$ cksum --debug -a md5 README.md
MD5 (README.md) = 15af838487236a3900e77e6b70e4d2a7
$ printf "test" | cksum --debug
cksum: avx512 support not detected
cksum: avx2 support not detected
cksum: using pclmul hardware support
3076352578 4
There was a problem hiding this comment.
you mean hardware capability detection :v
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR implements the
--debugflag for cksum, split from the original PR #8948.What's included:
--debugCLI argument with help text