Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-openonu-adapter-go / cc788a1977b5065c489c7cfc61f258f56c273a59
commitcc788a1977b5065c489c7cfc61f258f56c273a59[log] [tgz]
authorAndrea Campanella <andrea@opennetworking.org>Fri Jun 11 16:22:02 2021 +0200
committerAndrea Campanella <andrea@opennetworking.org>Mon Jun 14 12:59:32 2021 +0200
treeb78928fc36d35afcc9267bb524757f5d59469375
parent20d180c634696f7f0d93e8c5759d9108b85e21ce [diff]
Update ONU sw update documentation

Change-Id: Id922d6072f64effdc9355ec55b00515e97db3ee0
2 files changed
tree: b78928fc36d35afcc9267bb524757f5d59469375
  1. .gitignore
  2. .gitreview
  3. .golangci.yml
  4. Makefile
  5. ONU_Upgrade_Notes.md
  6. PM_Notes.md
  7. README.md
  8. VERSION
  9. cmd/
  10. docker/
  11. go.mod
  12. go.sum
  13. internal/
  14. pkg/
  15. templates/
  16. vendor/
README.md

How to Build the Golang based OpenONU Adapter

NOTE that this is a work in progress. A functional version is yet to come.

Working with Go Dependencies

This project uses Go Modules https://github.com/golang/go/wiki/Modules to manage dependencies. As a local best pratice this project also vendors the dependencies. If you need to update dependencies please follow the Go Modules best practices and also perform the following steps before committing a patch:

go mod tidy
go mod verify
go mod vendor

Building with a Local Copy of voltha-protos or voltha-lib-go

If you want to build/test using a local copy or voltha-protos or voltha-lib-go this can be accomplished by using the environment variables LOCAL_PROTOS and LOCAL_LIB_GO. These environment variables should be set to the filesystem path where the local source is located, e.g.

LOCAL\_PROTOS=$HOME/src/voltha-protos
LOCAL\_LIB\_GO=$HOME/src/voltha-lib-go

When these environment variables are set the vendored versions of these packages will be removed from the vendor directory and replaced by coping the files from the specified locations to the vendor directory. NOTE: this means that the files in the vendor directory are no longer what is in the git repository and it will take manual git intervention to put the original files back.