| commit | feeefe81b10f9dc3a9201391d1856c56fc11e02f | [log] [tgz] |
|---|---|---|
| author | Joey Armstrong <jarmstrong@linuxfoundation.org> | Wed Apr 10 15:58:40 2024 -0400 |
| committer | Joey Armstrong <jarmstrong@linuxfoundation.org> | Wed Apr 10 16:01:07 2024 -0400 |
| tree | 38e8c108eba7f58a9bb5495d3d2b68c71db09867 | |
| parent | a1e6ae0875b13dafe41281780f8f4cb6010eaea9 [diff] |
[VOL-5297] - (dep) Install pre-commit lint tool.
TODO.md
-------
o Capture detail for future repository enahancements.
o Populating TODO.md with a table of jira tickets would be a cleaner
answer but not enough enhacnement volume yet.
docs/Makefile
-------------
o Disable '$(RM) build' in the makefile clean target.
o rm build/ normally cleans sphinx generated documentation.
o Cannot perform this default clean action in repo:bbsim due to
files under VCS has been checked into directory build.
o 'make clean' inadvertenly breaks 'make lint' and 'make build'
Change-Id: Ib28caebdb82a3eb82dc9573606c2e2314dac8af7
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
BBSim is managed via a Makefile, plese run the following command to display all the available targets
make help
More advanced documentation lives in here.
You can generate and browse the documentation by executing:
make docs
This project structure is based on golang-standards/project-layout.