COVESA / capicxx-someip-tools

Common API C++ SOMEIP tooling
Mozilla Public License 2.0
76 stars 55 forks source link

Errors in build instructions in README #11

Closed slashingweapon closed 1 year ago

slashingweapon commented 4 years ago

The "Build instructions for Linux" section of the README.md file seem to have been copy-pasted from capicxx-core-tools and then incorrectly edited. For example:

You can build all code generators by calling maven from the command-line. Open a console and change in the directory org.genivi.commonapi.someip.releng of your CommonAPI-Tools directory

The directory "org.genivi.commapi.someip.releng" does not exist in the CommonAPI-Tools directory. It exists in the capicxx-someip-tools directory.

Also, the target file is named "org.genivi.commonapi.core.target.target", which seems like a bug.

I think the build instructions need to be scrubbed.

slashingweapon commented 4 years ago

Possibly the instructions are not in error, but are simply confusing.

When I built the capicxx-core-tools I had these instructions:

Open a console and change in the directory org.genivi.commonapi.core.releng of your CommonAPI-Tools directory.

In this case, the CommonAPI-Tools directory was where I checked out the project capicxx-core-tools.

But when I'm building the capicxx-someip-tools project, the "CommonAPI-Tools directory" refers to wherever I checked out the capicxx-someip-tools directory? Maybe?

"CommonAPI-Tools" directory sounds like a thing you must have before compiling the current project. It really sounds like some kind of pre-requisite. Maybe use a more obvious term instead, like "project directory", or "the directory where you cloned the project", or "your capicxx-someip-tools directory".

lixiaolia commented 4 years ago

Possibly the instructions are not in error, but are simply confusing.

When I built the capicxx-core-tools I had these instructions:

Open a console and change in the directory org.genivi.commonapi.core.releng of your CommonAPI-Tools directory.

In this case, the CommonAPI-Tools directory was where I checked out the project capicxx-core-tools.

But when I'm building the capicxx-someip-tools project, the "CommonAPI-Tools directory" refers to wherever I checked out the capicxx-someip-tools directory? Maybe?

"CommonAPI-Tools" directory sounds like a thing you must have before compiling the current project. It really sounds like some kind of pre-requisite. Maybe use a more obvious term instead, like "project directory", or "the directory where you cloned the project", or "your capicxx-someip-tools directory".

Hi guy, So, have you finished your compile successfully? When I compiled, I got the following error: [ERROR] Internal error: java.lang.RuntimeException: Failed to load p2 repository with ID 'core.cli' from location file:/home/xxx/src/capicxx-someip-tools/org.genivi.commonapi.core.cli.product/target/repository/: No repository found at file:/home/xxx/src/capicxx-someip-tools/org.genivi.commonapi.core.cli.product/target/repository. -> [Help 1] I don't know what went wrong. The maven command I use looks like this: cd ~/src/capicxx-someip-tools/org.genivi.commonapi.someip.releng mvn -DCOREPATH=/home/xxx/src/capicxx-someip-tools -Dtarget.id=org.genivi.commonapi.someip.target clean verify

Looking forward to your reply and help.

CalebProvost commented 4 years ago

When I compiled, I got the following error: [ERROR] Internal error: java.lang.RuntimeException: Failed to load p2 repository with ID 'core.cli' from location file:/home/xxx/src/capicxx-someip-tools/org.genivi.commonapi.core.cli.product/target/repository/: No repository found at file:/home/xxx/src/capicxx-someip-tools/org.genivi.commonapi.core.cli.product/target/repository. -> [Help 1] I don't know what went wrong. The maven command I use looks like this: cd ~/src/capicxx-someip-tools/org.genivi.commonapi.someip.releng mvn -DCOREPATH=/home/xxx/src/capicxx-someip-tools -Dtarget.id=org.genivi.commonapi.someip.target clean verify

Looking forward to your reply and help.

@lixiaolia

You're suppose to reference the CommonAPI Core Tools. This means your command should look as follows:

mvn clean verify -DCOREPATH=/home/xxx/src/capicxx-core-tools/ -Dtarget.id=org.genivi.commonapi.someip.target