mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-26 08:10:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: update development documentation

Browse Source 
Updated golang version to 1.13.x and
also updated user to set GO111MODULE=on
and CGO_ENABLED=1 when doing development
in cephcsi

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
This commit is contained in:
Madhu Rajanna 2020-05-04 15:08:02 +05:30 committed by mergify[bot]
parent 22a86c568e
commit 919f3b6d85
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/development-guide.md
View File

@ -13,10 +13,14 @@ it is **highly** encouraged to:
### Workspace and repository setup ### Workspace and repository setup
* [Download](https://golang.org/dl/) Go (>=1.11.x) and * [Download](https://golang.org/dl/) Go (>=1.13.x) and
[install](https://golang.org/doc/install) it on your system. [install](https://golang.org/doc/install) it on your system.
* Setup the [GOPATH](http://www.g33knotes.org/2014/07/60-second-count-down-to-go.html) * Setup the [GOPATH](http://www.g33knotes.org/2014/07/60-second-count-down-to-go.html)
environment. environment.
* `CGO_ENABLED` is enabled by default, if `CGO_ENABLED` is set to `0` we need
to set it to `1` as we need to build with go-ceph bindings.
* `GO111MODULE` is enabled by default, if `GO111MODULE` is set to `off` we need
to set it to `on` as cephcsi uses go modules for dependency.
* Ceph-CSI uses the native Ceph libaries through the [go-ceph * Ceph-CSI uses the native Ceph libaries through the [go-ceph
package](https://github.com/ceph/go-ceph). It is required to install the package](https://github.com/ceph/go-ceph). It is required to install the
Ceph C headers in order to compile Ceph-CSI. The packages are called Ceph C headers in order to compile Ceph-CSI. The packages are called