Add some discussion about overlays to dtc(1)

davidchisnall / dtc

FreeBSD Device Tree Compiler

19 stars 15 forks source link

Add some discussion about overlays to dtc(1) #34

Closed kevans91 closed 6 years ago

kevans91 commented 6 years ago

Add an OVERLAYS section to the man page with some background/information on overlays and how they should be created and subsequently used.
Add some examples relevant to generating and usage of overlays; primarily how to generate a base .dtb that may be amended with overlays, and how to generate an overlay as well as the standard extension to be used for overlays.

I'm bad with words and whatnot, so this might need some heavy editing.

kevans91 commented 6 years ago

I should probably note that I clearly have no expectation of this going in before PR #31 given that it references things specifically not supported until PR #31 is merged, and these two PRs together are the last two that I'd like to have merged before I import back to -HEAD.

davidchisnall commented 6 years ago

I'll merge now and do an editing pass later: some documentation is better than no documentation!

kevans91 commented 6 years ago

For what it's worth, I did consider popping it over to the manpages@ group on phabricator before submitting the PR- perhaps it might still not be a bad idea, then I'll just open a new PR with their requested edits?

davidchisnall commented 6 years ago

Probably a good idea to get them to do a full pass over the page and open a PR with their proposed edits.