adevtool/vendor-specs/README.md

This directory contains FileTreeSpecs for vendor modules of each of the supported devices.

FileTreeSpec specifies SHA-256 digest of each file in a file tree, and lists out all of its directories.

FileTreeSpec is used by `adevtool generate-all` command to verify vendor module that it generated against 
a reference module.

Reference module is generated by `adevtool generate-all --updateSpec` command, which writes a new
FileTreeSpec to this directory.
generate-all: verify the result against a reference FileTreeSpec This commit adds an extra step to generate-all: - if --updateSpec flag is specified, FileTreeSpec of the generated vendor module is written out to vendor-specs/$VENDOR/$DEVICE.yaml file ("reference FileTreeSpec"). - if --updateSpec is not specified, FileTreeSpec of the generated vendor module is compared against the reference FileTreeSpec. If there are any differences, generated vendor module is deleted and an exception is thrown. Also, when --updateSpec flag is used, text files inside vendor module are written out to vendor-skels/$VENDOR/$DEVICE directory. Contents of vendor-skels/ are useful for keeping track of vendor module changes via git and for showing diffs in case text files in the generated module don't match the reference ones. 2023-08-27 15:43:30 +02:00			`This directory contains FileTreeSpecs for vendor modules of each of the supported devices.`

			`FileTreeSpec specifies SHA-256 digest of each file in a file tree, and lists out all of its directories.`

			FileTreeSpec is used by `adevtool generate-all` command to verify vendor module that it generated against
			`a reference module.`

			Reference module is generated by `adevtool generate-all --updateSpec` command, which writes a new
			`FileTreeSpec to this directory.`