From 42acd46b3a88556ef12260bd85fcd97ddedd63dd Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Fri, 12 Mar 2021 09:45:28 +0100 Subject: [PATCH 1/2] fix build instructions --- docs/ocis/development/build.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/ocis/development/build.md b/docs/ocis/development/build.md index f5a610a3f4..461f32f7bb 100644 --- a/docs/ocis/development/build.md +++ b/docs/ocis/development/build.md @@ -22,15 +22,23 @@ cd ocis ## Build the oCIS binary -The oCIS binary source is in the `ocis` folder inside the oCIS repository. In this folder you can build the oCIS binary: +Only if you have changed protobuf definitions or the frontend part in one of the extensions, you need to run following command in the root directory of the repository. Otherwise you can skip this step and proceed building the oCIS binary. +This will at least modify multiple `embed.go` files because we embed the frontend build output in these `embed.go` files and a timestamp will be updated and also minor differences are expected between different Node.js versions. + +{{< highlight txt >}} +make generate +{{< / highlight >}} + +The next step is to build the actual oCIS binary. Therefore you need to navigate to the subdirectory `ocis` and start the build process. {{< highlight txt >}} cd ocis -make generate make build {{< / highlight >}} -After building you have the binary within the `bin/` folder. Try to run it: `./bin/ocis h` +After the build process finished, you can find the binary within the `bin/` folder (in `ocis/bin` relative to the oCIS repository root folder). + +Try to run it: `./bin/ocis h` ## Build a local oCIS docker image From 5d15b0c86d4133ad4540a189f1091cdd3d134b4e Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Sat, 13 Mar 2021 11:15:14 +0545 Subject: [PATCH 2/2] Apply suggestions from code review of build.md --- docs/ocis/development/build.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ocis/development/build.md b/docs/ocis/development/build.md index 461f32f7bb..d4a8e9182c 100644 --- a/docs/ocis/development/build.md +++ b/docs/ocis/development/build.md @@ -22,8 +22,8 @@ cd ocis ## Build the oCIS binary -Only if you have changed protobuf definitions or the frontend part in one of the extensions, you need to run following command in the root directory of the repository. Otherwise you can skip this step and proceed building the oCIS binary. -This will at least modify multiple `embed.go` files because we embed the frontend build output in these `embed.go` files and a timestamp will be updated and also minor differences are expected between different Node.js versions. +You only need to run following command if you have changed protobuf definitions or the frontend part in one of the extensions. Run the command in the root directory of the repository. Otherwise you can skip this step and proceed to build the oCIS binary. +This will usually modify multiple `embed.go` files because we embed the frontend build output in these `embed.go` files and a timestamp will be updated and also minor differences are expected between different Node.js versions. {{< highlight txt >}} make generate