Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix example and language in manpage #636

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

mb720
Copy link

@mb720 mb720 commented Oct 29, 2023

Hi and thanks a lot for rmlint!

I'd like to offer some improvements for the manpage.

It's mostly typo fixes and attempts to make the manpage easier to read.

But I think I also spotted an error in the examples. In the old version, rmlint -e was described as

Find duplicates with same basename (excluding extension)

Yet I'm pretty sure that option -b does that, whereas -e makes rmlint consider two files as duplicates only if their extensions match.

This command makes ``rmlint`` exit with one of the following exit codes:

* 0: files are reflinks
* 1: files are not reflinks
* 3: not a regular file
* 4: file sizes differ
* 5: fiemaps can't be read
* 6: file1 and file2 are the same path
* 6: file1 and file2 are at the same path
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this change. This status is for when the two paths provided are literally the same path after resolving symlinks, hence no data needs to be looked at. Maybe we could say "have the same path", but I'd have to think about it - technically, no two files can have the same path, because that would mean they're the same file.

Copy link
Author

@mb720 mb720 Oct 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "path1" and "path2" are more suitable argument names. Then this could read:

6: path1 and path2 point to the same file (after resolving symlinks)

Come to think of it, this sounds reasonable as well:

6: file1 and file2 are the same (after resolving symlinks)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, "the same file" is ambiguous here, because it could be taken to mean "the same inode." But that's a hardlink - two different paths that point to the same file. The paths themselves are equal after resolving symlinks in this case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants