category of YAML diff?

[pavt]

Hey all, thanks for this great tool!

Can you please help me with the following questions?:

• How can I get diff types from YAML files?
• Is there a set of categories for this? Docs?

I have been looking for docs for this, but I didn't find it.

Thank you

[HeavyWombat]

Hello, I am not sure I fully understand the question. Is it about what kind of differences dyff can detect and report? So far, I have not considered documenting internals in a separate document. Mostly, because I kind of wrote the tool around use cases we had. Roughly speaking, it differentiates additions, removals, and modifications. The respective reporting style can show those differences more detailed.

Out of the top my head, the default human output has the following differences it detects:

• new content added
• content removed
• type changed (i.e. from number to string), this is helpful to find accidental type changes
• order in list changes (sometimes crucial, depends on the use case)
• certificate changes (tool does decode the certificate to compare individual fields)
• whitespace only changes (killer feature in the BOSH world, where such simple changes could trigger a deployment)
• line change in multi-line strings
• minor changes in texts (only a few characters were changed), useful for TYPO detection