• Home
  • Annotate
  • current directory
Name Date Size #Lines LOC

..21-Aug-2025-

README.rst A D21-Aug-20252.5 KiB5531

README.rst

1**Purpose of this folder**
2
3This folder serves as a hook to add proprietary ACRN configuration for package building. To avoid polluting ``misc/config_tools/data`` with otherwise unsupported configurations, any additional board and scenario configurations can be put in here (``debian/configs``) using the same structure as in ``misc/config_tools/data``:
4
5::
6
7  debian/configs + <board name> + <board name>.xml
8                                |
9                                + <scenario 1>.xml
10                                ..
11                                + <scenario n>.xml
12
13
14This enables an easy merge form acrn-hypervisor repository without any merge conflict. To get any changes built into the package you have to commit your changes, since ``git-buildpackage`` always requires this to be able to reproduce a package without impact of local changes.
15
16To add proprietary configuration, you create a proper working branch:
17
18::
19
20  me@devhost:~/acrn-work/acrn-hypervisor$ git checkout -b my-proprietary-acrn-package
21
22Add your proprietary configuration, e.g., adding a configuration for a NUC7i7DNHE system with a new-shared scenario:
23
24::
25
26  me@devhost:~/acrn-work/acrn-hypervisor$ mkdir -p debian/configs/nuc7i7dnhe
27  me@devhost:~/acrn-work/acrn-hypervisor$ cp <your-config-path>/nuc7i7dnhe.xml debian/configs/nuc7i7dnhe/
28  me@devhost:~/acrn-work/acrn-hypervisor$ cp <your-config-path>/new-shared.xml debian/configs/nuc7i7dnhe/
29
30Create a ``debian/configs/configurations.mk`` with the following contents:
31
32::
33
34  me@devhost:~/acrn-work/acrn-hypervisor$ cat debian/configs/configurations.mk
35  ACRN_BOARDLIST += nuc7i7dnhe
36  ACRN_SCENARIOLIST += new-shared
37
38This adds nuc7i7dnhe:new-shared to the configuration built-into ``acrn-hypervisor`` package. Commit yor changes
39
40::
41
42  me@devhost:~/acrn-work/acrn-hypervisor$ git add debian/configs/nuc7i7dnhe debian/configs/configurations.mk
43  me@devhost:~/acrn-work/acrn-hypervisor$ git commit -s -m "Add nuc7i7dnhe:new-shared"
44
45Now you can use this branch ``my-proprietary-acrn-package`` to build the ACRN packages including your new config:
46
47::
48
49  me@devhost:~/acrn-work/acrn-hypervisor$  DISTRO=<your distro> VENDOR=<your vendor> debian/docker/acrn-docker-build.sh --git-ignore-branch
50
51This can then easily be rebased onto any ACRN changes whenever required without any merge-issues.
52
53*Remark*: For a quick solution without the need to commit your changes you can circumvent ``git-buildpackage`` using the procedure outlined `here <../README.rst#development-build-from-source-package>`__.
54
55