commit | 96bcf1b0c8c12c03aa4b761b05b932245990ca8a | [log] [tgz] |
---|---|---|
author | Joey Armstrong <joey@opennetworking.org> | Tue Jun 27 14:49:40 2023 -0400 |
committer | Joey Armstrong <joey@opennetworking.org> | Thu Jul 20 15:11:59 2023 -0400 |
tree | 695f242057f1f8ba0e32d3ad787d4d110acd51d9 | |
parent | 84b5bb9cee4adacbec4325025e962bc5bc51e1b7 [diff] |
[VOL-5051] - Triage bbsim build [VOL-5092] - verify_bbsim_unit-test repository failures in jenkins job history. makefiles/* ----------- o Merge in latest library makefiles. o Some legacy retained: tools.mk => makefiles/docker/include.mk makefiles/lint/docker/*.mk (replace with docker/include.mk.new) Makefile -------- o Remove bogus foobar target. o Target docs-lint now maps to library target lint-doc8. docs/Makefile ------------- o venv install now handled by makefiles/virtualenv.mk o Replaced inlined doc8 lint target with makefiles/lint/doc8 (lint-doc8) o Use std defines for SHELL= and other constants. o Replace separator ';' with '&&' in commands using venv (detect errors). config.mk --------- o Enable lint targets for doc8, docker & json. o More lint checks can be enabled but cleanup is needed first. docs/Makefile requirements.txt ---------------- o Identified a few python module problems documented in VOL-5092. o Makefile wild target(%) matching stray dependencies so hardcode sphinx targets to act on. o Added hyphen/success to "make docs" until VOL-5092 can be straightened out. Change-Id: Ibe4006747ee610bfe8ac0fdbb339e5e18e6e9176
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.