Cerebellum-Network / ddc-schemas

Apache License 2.0
0 stars 0 forks source link

Make docs does not work #44

Open calmrat opened 1 year ago

calmrat commented 1 year ago

$> git clone https://github.com/Cerebellum-Network/ddc-schemas.git Cloning into 'ddc-schemas'... remote: Enumerating objects: 596, done. remote: Counting objects: 100% (153/153), done. remote: Compressing objects: 100% (83/83), done. remote: Total 596 (delta 75), reused 74 (delta 70), pack-reused 443 Receiving objects: 100% (596/596), 89.96 KiB | 2.09 MiB/s, done. Resolving deltas: 100% (351/351), done. $> cd ddc-schemas $> make docs

Building docs for schema storage... docker run --rm \ -v /Users/cward/Repos/ddc-schemas:/repo \ rvolosatovs/protoc:3.3 \ --proto_path=/repo/storage/protobuf \ --doc_out=/repo/build/tmp \ --doc_opt=/repo/markdown.tmpl,storage-protobuf.md \ $(find storage/protobuf -name '.proto' -type f | sed 's/.\///' | sort); \

docker: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?. See 'docker run --help'. make: *** [docs-storage] Error 125

...

After Installing and running Docker, then running make docs, it helped. But still got an error.

$> make docs

Building docs for schema storage... docker run --rm \ -v /Users/cward/Repos/ddc-schemas:/repo \ rvolosatovs/protoc:3.3 \ --proto_path=/repo/storage/protobuf \ --doc_out=/repo/build/tmp \ --doc_opt=/repo/markdown.tmpl,storage-protobuf.md \ $(find storage/protobuf -name '.proto' -type f | sed 's/.\///' | sort); \

Unable to find image 'rvolosatovs/protoc:3.3' locally 3.3: Pulling from rvolosatovs/protoc 59bf1c3509f3: Pull complete a507ac90b360: Pull complete 3cd4690eda9d: Pull complete 3dc4384c619b: Pull complete 4fa77e36ae9d: Pull complete 8d4c00539764: Pull complete 1d742b8ff6d7: Pull complete f60a84168ad3: Pull complete Digest: sha256:046396984aa7b9c2bb42d842ada9a503ce80974adb58395426edc1145b9a0eb1 Status: Downloaded newer image for rvolosatovs/protoc:3.3 WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested qemu: uncaught target signal 11 (Segmentation fault) - core dumped --doc_out: protoc-gen-doc: Plugin killed by signal 11. make: *** [docs-storage] Error 1

Running on a Macbook.

Updated the docker command in the Makefile to include --platform linux/amd64

Still crashing with error. qemu: uncaught target signal 11 (Segmentation fault) - core dumped --doc_out: protoc-gen-doc: Plugin killed by signal 11. make: *** [docs-storage] Error 1

Please advise how to improve the readme instructions for Mac user to build the docs. Thanks!

calmrat commented 1 year ago

make js is failing too. Please let mw know what parameters i need to change to build the docs.