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

Documentation uses "props" without defining it #960

Open
Korb opened this issue Sep 7, 2023 · 1 comment
Open

Documentation uses "props" without defining it #960

Korb opened this issue Sep 7, 2023 · 1 comment
Labels
defect unison fails to meet its specification (but doesn't crash; see also "crash") effort-medium issue is likely resolvable with <= 20h of effort impact-low low importance

Comments

@Korb
Copy link

Korb commented Sep 7, 2023

Currently, the User Manual and Reference Guide does not mention the word "props" even once, although it is one of the comparison results along with "chgd dir", "deleted" and "new file". The wiki does not mention this word either.

I propose to consider adding to the application's help system a list of possible values ​​of the comparison results and an explanation of who each of them means. In particular, is a file stream change a file change, or a property change, and is it taken into account at all? If you add EXIF tags to an image, is that a file change, or a property change? Similarly with XMP tags of files.

@tleedjarv
Copy link
Contributor

I think the request is valid and should remain open (this would also be a good issue for a new contributor to tackle!). In an attempt to explain very shortly, I'd say that "props" are any synced filesystem properties associated with a file. Typical examples are modification time, permissions (also read-only flag), owner and such. As EXIF tags are stored within the image file as part of file's data, not somehow separately by the filesystem, these would not be "props". For a user, the difference may not be too obvious, so a clarification in the docs sounds like a good idea.

In particular, is a file stream change a file change, or a property change, and is it taken into account at all?

Streams are currently not synced at all. If they were, they'd be listed as properties change, though.

@gdt gdt added defect unison fails to meet its specification (but doesn't crash; see also "crash") impact-low low importance effort-medium issue is likely resolvable with <= 20h of effort labels Sep 17, 2023
@gdt gdt changed the title Add to the User Guide a list of properties related to the difference type "props" Documentation uses "props" without defining it Sep 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect unison fails to meet its specification (but doesn't crash; see also "crash") effort-medium issue is likely resolvable with <= 20h of effort impact-low low importance
Projects
None yet
Development

No branches or pull requests

3 participants