Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Contributing to oneAPI-samples

The `master` branch contains code samples that work with the latest released version of the [Intel® oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html). Do not commit change to the `master` branch.
The `main` branch contains code samples that work with the latest released version of the [Intel® oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html). Do not commit change to the `main` branch.

All contributions must go into the `development` branch through a pull request (PR) where they will be reviewed before being merged. At specific dates, corresponding to the releases of the oneapi DPC++/C++ compiler, the `development` branch is merged into the `master` branch.
All contributions must go into the `development` branch through a pull request (PR) where they will be reviewed before being merged. At specific dates, corresponding to the releases of the oneapi DPC++/C++ compiler, the `development` branch is merged into the `main` branch.

## Fork the Repository

1. To fork the repository from the GitHub user interface, click the **Fork** icon then select **Create a new fork**. The fork will be created in few seconds. If you previously forked the repo, skip to the Step 5.

2. Select an **Owner** for the forked repository.

3. Deselect the **Copy the master branch only** check box. (It should be unchecked before proceeding to the next step.)
3. Deselect the **Copy the main branch only** check box. (It should be unchecked before proceeding to the next step.)

4. Click the **Create fork** button.

Expand Down Expand Up @@ -50,7 +50,7 @@ When submitting a pull request, keep the following guidelines in mind:

- Check the number of files being updated. Ensure that your pull request includes only the files you expected to be changed. (If there are additional files you did not expect included in the commit, troubleshoot before submitting the PR.)

- Never open a pull request to the `master` branch directly, all pull requests must be targeting the `development` branch.
- Never open a pull request to the `main` branch directly, all pull requests must be targeting the `development` branch.

## Log a Bug or Request a Feature

Expand All @@ -59,11 +59,13 @@ We use [GitHub Issues](https://github.com/oneapi-src/oneAPI-samples/issues) to t
When reporting a bug, provide the following information when possible:

- Steps to reproduce the bug.
- Whether you found or reproduced the bug using the latest sample in the `master` branch and the latest Intel® oneAPI Toolkits.
- Whether you found or reproduced the bug using the latest sample in the `main` branch and the latest Intel® oneAPI Toolkits.
- Version numbers or other information about the CPU/GPU/FPGA/device, platform, operating system or distribution you used to find the bug.

For usage, installation, or other requests for help, go to the [Intel® oneAPI Forums](https://software.intel.com/en-us/forums/intel-oneapi-forums) for more information.

## License

Code samples in this repository are licensed under the terms outlined in [License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
Code samples in this repository are licensed under the terms outlined in [License.txt](License.txt).

By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
Empty file removed DirectProgramming/C++/.gitkeep
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The basic steps to build and run a sample using VS Code include:
3. Open a terminal in VS Code (**Terminal > New Terminal**).
4. Run the sample in the VS Code terminal using the instructions below.

To learn more about the extensions and how to configure the oneAPI environment, see the
To learn more about the extensions and how to configure the oneAPI environment, see the
[Using Visual Studio Code with Intel® oneAPI Toolkits User Guide](https://www.intel.com/content/www/us/en/develop/documentation/using-vs-code-with-intel-oneapi/top.html).

### On Linux*
Expand Down Expand Up @@ -150,6 +150,6 @@ Saving image as mandelbrot_simd_parallel.png
## License

Code samples are licensed under the MIT license. See
[License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt) for details.
[License.txt](License.txt) for details.

Third party program licenses are at [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).
Third party program licenses are at [third-party-programs.txt](third-party-programs.txt).
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The basic steps to build and run a sample using VS Code include:
3. Open a terminal in VS Code (**Terminal > New Terminal**).
4. Run the sample in the VS Code terminal using the instructions below.

To learn more about the extensions and how to configure the oneAPI environment, see the
To learn more about the extensions and how to configure the oneAPI environment, see the
[Using Visual Studio Code with Intel® oneAPI Toolkits User Guide](https://www.intel.com/content/www/us/en/develop/documentation/using-vs-code-with-intel-oneapi/top.html).

### On Linux*
Expand Down Expand Up @@ -119,6 +119,6 @@ DAZ is set.
## License

Code samples are licensed under the MIT license. See
[License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt) for details.
[License.txt](License.txt) for details.

Third party program Licenses can be found here: [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).
Third party program Licenses can be found here: [third-party-programs.txt](third-party-programs.txt).
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The basic steps to build and run a sample using VS Code include:
3. Open a terminal in VS Code (**Terminal > New Terminal**).
4. Run the sample in the VS Code terminal using the instructions below.

To learn more about the extensions and how to configure the oneAPI environment, see the
To learn more about the extensions and how to configure the oneAPI environment, see the
[Using Visual Studio Code with Intel® oneAPI Toolkits User Guide](https://www.intel.com/content/www/us/en/develop/documentation/using-vs-code-with-intel-oneapi/top.html).

### On Linux*
Expand Down Expand Up @@ -97,28 +97,6 @@ If you receive an error message, troubleshoot the problem using the **Diagnostic
make clean
```

### Build and Run the `OpenMP Offload` Sample in Intel® DevCloud (Optional)

When running a sample in the Intel® DevCloud, you must specify the compute node (CPU, GPU, FPGA) and whether to run in batch or interactive mode. You can specify a GPU node using a single line script.

```
qsub -I -l nodes=1:gpu:ppn=2 -d .
```

- `-I` (upper case I) requests an interactive session.
- `-l nodes=1:gpu:ppn=2` (lower case L) assigns one full GPU node.
- `-d .` makes the current folder as the working directory for the task.

|Available Nodes |Command Options
|:--- |:---
|GPU |qsub -l nodes=1:gpu:ppn=2 -d .
|CPU |qsub -l nodes=1:xeon:ppn=2 -d .

For more information on how to specify compute nodes read, [Launch and manage jobs](https://devcloud.intel.com/oneapi/documentation/job-submission/) in the Intel® DevCloud for oneAPI Documentation.

For more information on using Intel® DevCloud, see the Intel® oneAPI Base Toolkit [Get Started Guide](https://devcloud.intel.com/oneapi/get_started/).


## Example Output

### Prog1 Example Output
Expand Down Expand Up @@ -179,8 +157,8 @@ Built target run_prog4
## License

Code samples are licensed under the MIT license. See
[License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt)
[License.txt](License.txt)
for details.

Third party program licenses are at
[third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).
Third party program licenses are at
[third-party-programs.txt](third-party-programs.txt).
Loading