-
Notifications
You must be signed in to change notification settings - Fork 54
/
Copy pathREADME
95 lines (80 loc) · 3.68 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
IPC CommonAPI C++ SomeIP Tools
------------------------------
:doctitle: IPC CommonAPI C++ SomeIP Tools
:version:
Copyright
+++++++++
Copyright (C) 2015-2023, Bayerische Motoren Werke Aktiengesellschaft (BMW AG).
Copyright (C) 2015-2023, COVESA
This file is part of COVESA Project IPC Common API C++.
Contributions are licensed to the COVESA under one or more Contribution License Agreements or MPL 2.0.
License
+++++++
This Source Code Form is subject to the terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not distributed with this file, you can obtain one
at http://mozilla.org/MPL/2.0/.
Version
+++++++
{version}
Build Instructions
~~~~~~~~~~~~~~~~~~
An automated build process via Maven for the update-site and the command line
interface is provided.
To build, change into the `org.genivi.commonapi.someip.releng` directory and
run:
----
mvn clean verify -DCOREPATH=< path to your CommonAPI-Tools dir> -Dtarget.id=org.genivi.commonapi.someip.target
----
If no configuration files are changed, Maven should report successful
compilation of the following items:
----
org.genivi.commonapi.someip.releng
org.genivi.commonapi.someip.target
org.genivi.commonapi.someip
org.genivi.commonapi.someip.ui
org.genivi.commonapi.someip.feature
org.genivi.commonapi.someip.cli
org.genivi.commonapi.someip.cli.feature
org.genivi.commonapi.someip.cli.product
org.genivi.commonapi.someip.validator
org.genivi.commonapi.someip.validator.feature
org.genivi.commonapi.someip.updatesite
----
The command line interface will be built for different platforms, with a zip-file
as generated output. The zip-file can be found in
`org.genivi.commonapi.someip.cli.product/target/products`.
The unzipped results are located in
`org.genivi.commonapi.someip.cli.product/target/products/org.genivi.commonapi.someip.cli.product`
An osgi based application will be contained in the zip-file.
If the application is started without any parameters, the available commandline
parameters are printed. For example:
----
./org.genivi.commonapi.someip.cli.product/target/products/org.genivi.commonapi.someip.cli.product/linux/gtk/x86_64/commonapi-someip-generator-linux-x86_64
Command: Console Help
usage: commonapi-someip-generator-linux-x86_64 -h
-h,--help display help of available console commands
Command: Version Information
usage: commonapi-someip-generator-linux-x86_64 [-a | -p] -v
-a,--all print code generator and plug-in versions
-p,--plugins print plug-in versions
-v,--version print code generator version
Command: CommonAPI Some/IP Code Generation
usage: commonapi-someip-generator-linux-x86_64 [-d <arg>] [-dc <arg>] [-dp
<arg>] [-ds <arg>] [-l <arg>] [-ll <arg>] [-ng] [-np] [-ns] [-nsc] [-nv]
[-pf] [-sp <arg>] [-wod]
-d,--dest <arg> The default output directory
-dc,--dest-common <arg> The directory for the common code
-dp,--dest-proxy <arg> The directory for proxy code
-ds,--dest-stub <arg> The directory for stub code
-l,--license <arg> The file path to the license text that will be
added to each generated file
-ll,--loglevel <arg> The log level (quiet or verbose)
-ng,--no-gen Switch off code generation
-np,--no-proxy Switch off generation of proxy code
-ns,--no-stub Switch off generation of stub code
-nsc,--no-sync-calls Switch off code generation of synchronous methods
-nv,--no-val Switch off validation of the fdepl file
-pf,--printfiles Print out generated files
-sp,--searchpath <arg> The search path to contain fidl/fdepl files
-wod,--without-dependencies Switch off code generation of dependencies
----