bcpierce00 / unison

Unison file synchronizer
GNU General Public License v3.0
3.86k stars 224 forks source link

Documentation uses "props" without defining it #960

Open Korb opened 10 months ago

Korb commented 10 months ago

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 commented 10 months ago

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.