ergoplatform / ergo

Ergo protocol description & reference client implementation
https://ergoplatform.org/
Creative Commons Zero v1.0 Universal
499 stars 169 forks source link

GNU/Linux Debian 11 - v5.0.2 - [error] (Compile / doc) Scaladoc generation failed #1897

Closed blackmennewstyle closed 1 year ago

blackmennewstyle commented 1 year ago

Hello,

I'm trying to build ERGO from the sources but i'm getting an error which prevents it to be successfully built. Here a full log of the issue:

wget https://github.com/ergoplatform/ergo/archive/refs/tags/v5.0.2.tar.gz
tar -xvf v5.0.2.tar.gz
cd ergo-5.0.2
sbt debian:packageBin
[info] Loading settings for project ergo-5-0-2-build from plugins.sbt ...
[info] Loading project definition from /home/ceedii/ergo-5.0.2/project
[info] Loading settings for project ergo from build.sbt ...
[info] Loading settings for project benchmarks from build.sbt ...
[info] Loading settings for project ergoWallet from build.sbt ...
[info] Loading settings for project avldb from build.sbt ...
[info] Set current project to ergo (in build file:/home/ceedii/ergo-5.0.2/)
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/mining/CandidateGenerator.scala:78:5: discarding unmoored doc comment
[error]     /** first we need to get Readers to have some initial state to work with */
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/mining/CandidateGenerator.scala:122:5: discarding unmoored doc comment
[error]     /**
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/mining/ErgoMiner.scala:74:5: discarding unmoored doc comment
[error]     /** at first keep trying to obtain secret and public key as we cannot mine without it */
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/mining/ErgoMiner.scala:149:5: discarding unmoored doc comment
[error]     /**
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/modifiers/history/BlockTransactions.scala:153:5: discarding unmoored doc comment
[error]     /**
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/history/ErgoHistoryReader.scala:353:5: discarding unmoored doc comment
[error]     /**
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/state/UtxoState.scala:160:15: discarding unmoored doc comment
[error]               /**
[error]               ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletActor.scala:127:5: discarding unmoored doc comment
[error]     /** READERS */
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletActor.scala:199:5: discarding unmoored doc comment
[error]     /** STATE CHANGE */
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletActor.scala:224:5: discarding unmoored doc comment
[error]     /** SCAN COMMANDS */
[error]     ^
[error] /home/ceedii/ergo-5.0.2/src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletActor.scala:305:7: discarding unmoored doc comment
[error]       /** WALLET COMMANDS */
[error]       ^
[info] SHA-1: e4b1a3e22eab9166a2ee211d082b3c476ac19bf9
[error] (Compile / doc) Scaladoc generation failed
[error] Total time: 16 s, completed Nov 6, 2022, 7:56:16 AM

Is there a way to bypass that error? The full log is attached for even more details. build.log

pragmaxim commented 1 year ago

There is no such sbt task as debian:packageBin available ... do just sbt assembly and then run it with something like : java -Xmx4g -jar ergo.jar --mainnet -c ergo.conf

See https://docs.ergoplatform.com/node/install/manual/

blackmennewstyle commented 1 year ago

There is no such sbt task as debian:packageBin available ... do just sbt assembly and then run it with something like : java -Xmx4g -jar ergo.jar --mainnet -c ergo.conf

See https://docs.ergoplatform.com/node/install/manual/

Thanks for the answer. You guys should probably consider upgrading the README.md because it is clearly saying the opposite, it is the first things people see when they visit the ERGO repository.