builder - jimmytwei/oneAPI-samples GitHub Wiki

builder is an optional array field that indicates the preferred builder to be used by the sample browsers. The possible values are:

  • cli
  • cmake
  • ide
  • make

If the builder field is not specified in the sample.json file, cmake will be the default builder.

Specifying cli in the builder array will make the code sample visible in both the oneapi-cli tool and Visual Studio Code. The Visual Studio and Eclipse sample browsers will not display the sample in their list of available samples.

Specifying cmake in the builder array means that the code sample is a CMake managed project and that a CMakeLists.txt file is present in the sample's root folder.

Specifying ide in the builder array means the code sample contains specific project files that will be imported into the IDE (i.e. a Visual Studio solution file or an Eclipse project file is included with the code sample).

Specifying make in the builder array means the code sample includes a Makefile in the sample's root folder.

More than one "builder" can be specified in the builder array. The order of the array elements is important, as the samples browsers will evaluate the list of provided builders in the order presented by the array.

The builder field in your sample.json file should have a format similar to the following:

"builder": [ "ide", "make" ]