duplicates: improve the checksum option docs - #6913
Open
cycsmail wants to merge 1 commit into
Open
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
Description
Fixes #3979.
The docs suggested
beet dup -C 'md5sum {file}'as a checksum command, but it can never match anything: the plugin uses the command's entire output as the checksum, and md5sum prints the file's path after the hash, so two copies of the same file always look different. The docs also didn't explain how the command is run (split shlex-style with{file}substituted per argument, no shell, so no pipes or redirection).Reworded the
checksumoption description to cover that, dropped the broken md5sum example and added a small wrapper-script recipe for commands like md5sum. I checked the recipe end to end on a throwaway library with duplicate files (paths with spaces included); the duplicates plugin tests pass and sphinx-lint/docstrfmt are clean on the changed files.To Do
Tests(docs-only change)