Updating submodules¶
Move a driver to a newer commit, check it and open the pull request that pins it.
- Merge the change in the driver's repository first. The umbrella only ever points at commits on a driver's
main. -
Bump the pointer here.
-
Build it where it is used. Point hf-core's
hf-core-driverssubmodule at your branch and run its host build and the ESP32 examples of the boards that enable the driver. - Open the pull request here, naming the driver change it brings in. After the merge, bump
hf-core-driversin hf-core.
Adding a driver¶
git submodule add https://github.com/hardfoc/<repo>.git external/<repo>.- Add an entry for it to
tools/docs/drivers.yml: group, chip, vendor, function, bus, language and whether it has a documentation site. Check each fact against the driver's README. - Run
hardfoc-docs genandmkdocs build --strict; the catalogue gains a card.
Checking where every submodule points¶
git submodule status # commit of each submodule; a leading '-' means not initialised
git submodule foreach --quiet 'echo "$name $(git describe --tags --always)"'
Next: Coding standards.