diff --git a/docs/markdown/hip_faq.md b/docs/markdown/hip_faq.md index f1d8c607ea..5e722383df 100644 --- a/docs/markdown/hip_faq.md +++ b/docs/markdown/hip_faq.md @@ -4,23 +4,21 @@ **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [FAQ](#faq) -- [Table of Contents](#table-of-contents) - - [What APIs does HIP support?](#what-apis-does-hip-support) - - [What is not supported?](#what-is-not-supported) - - [Run-time features:](#run-time-features) - - [How does HIP compare with OpenCL?](#how-does-hip-compare-with-opencl) - - [What hardware does HIP support?](#what-hardware-does-hip-support) - - [Does Hipify automatically convert all source code?](#does-hipify-automatically-convert-all-source-code) - - [What is NVCC?](#what-is-nvcc) - - [What is HCC?](#what-is-hcc) - - [Why use HIP rather than supporting CUDA directly?](#why-use-hip-rather-than-supporting-cuda-directly) - - [Can I develop HIP code on an Nvidia CUDA platform?](#can-i-develop-hip-code-on-an-nvidia-cuda-platform) - - [Can I develop HIP code on an AMD HCC platform?](#can-i-develop-hip-code-on-an-amd-hcc-platform) - - [Can a HIP binary run on both AMD and Nvidia platforms?](#can-a-hip-binary-run-on-both-amd-and-nvidia-platforms) - - [Hmmm](#hmmm) - - [Link2 Is it ready?](#link2-is-it-ready) - - [What's the difference between HIP and hc?](#whats-the-difference-between-hip-and-hc) +- [What APIs does HIP support ?](#what-apis-does-hip-support-) +- [What is not supported?](#what-is-not-supported) + - [Run-time features](#run-time-features) + - [Kernel language features](#kernel-language-features) +- [How does HIP compare with OpenCL?](#how-does-hip-compare-with-opencl) +- [What hardware does HIP support?](#what-hardware-does-hip-support) +- [Does Hipify automatically convert all source code?](#does-hipify-automatically-convert-all-source-code) +- [What is NVCC?](#what-is-nvcc) +- [What is HCC?](#what-is-hcc) +- [Why use HIP rather than supporting CUDA directly?](#why-use-hip-rather-than-supporting-cuda-directly) +- [Can I develop HIP code on an Nvidia CUDA platform?](#can-i-develop-hip-code-on-an-nvidia-cuda-platform) +- [Can I develop HIP code on an AMD HCC platform?](#can-i-develop-hip-code-on-an-amd-hcc-platform) +- [Can a HIP binary run on both AMD and Nvidia platforms?](#can-a-hip-binary-run-on-both-amd-and-nvidia-platforms) +- [What's the difference between HIP and hc?](#whats-the-difference-between-hip-and-hc) +- [HIP detected my platform (hcc vs nvcc) incorrectly - what should I do?](#hip-detected-my-platform-hcc-vs-nvcc-incorrectly---what-should-i-do) ================= diff --git a/docs/markdown/hip_kernel_language.md b/docs/markdown/hip_kernel_language.md index 23cde7fee6..9ac1a48a25 100644 --- a/docs/markdown/hip_kernel_language.md +++ b/docs/markdown/hip_kernel_language.md @@ -26,6 +26,7 @@ - [Single Precision Mathematical Functions](#single-precision-mathematical-functions) - [Double Precision Mathematical Functions](#double-precision-mathematical-functions) - [Integer Intrinsics](#integer-intrinsics) + - [Floating-point Intrinsics](#floating-point-intrinsics) - [Texture Functions](#texture-functions) - [Surface Functions](#surface-functions) - [Timer Functions](#timer-functions) diff --git a/docs/markdown/hip_porting_guide.md b/docs/markdown/hip_porting_guide.md index de5c590e12..5fcec1ae8e 100644 --- a/docs/markdown/hip_porting_guide.md +++ b/docs/markdown/hip_porting_guide.md @@ -1,3 +1,49 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [HIP Porting Guide](#hip-porting-guide) +- [###Table of Contents](#table-of-contents) + - [Porting a New Cuda Project](#porting-a-new-cuda-project) + - [General Tips](#general-tips) + - [Scanning existing CUDA code to scope the porting effort](#scanning-existing-cuda-code-to-scope-the-porting-effort) + - [Converting a project "in-place"](#converting-a-project-in-place) + - [Distinguishing Compiler Modes](#distinguishing-compiler-modes) + - [Identifying HIP Target Platform](#identifying-hip-target-platform) + - [Identifying the Compiler: hcc or nvcc](#identifying-the-compiler-hcc-or-nvcc) + - [Identifying Current Compilation Pass: Host or Device](#identifying-current-compilation-pass-host-or-device) + - [Compiler Defines: Summary](#compiler-defines-summary) + - [Identifying Architecture Features](#identifying-architecture-features) + - [HIP_ARCH Defines](#hip_arch-defines) + - [Device-Architecture Properties](#device-architecture-properties) + - [Table of Architecture Properties](#table-of-architecture-properties) + - [Finding HIP](#finding-hip) + - [Compiler Options](#compiler-options) + - [Linking Issues](#linking-issues) + - [Linking With hipcc](#linking-with-hipcc) + - [-lm Option](#-lm-option) + - [Linking Code With Other Compilers](#linking-code-with-other-compilers) + - [libc++ and libstdc++](#libc-and-libstdc) + - [HIP Headers (hip_runtime.h, hip_runtime_api.h)](#hip-headers-hip_runtimeh-hip_runtime_apih) + - [Using a Standard C++ Compiler](#using-a-standard-c-compiler) + - [cuda.h](#cudah) + - [Choosing HIP File Extensions](#choosing-hip-file-extensions) + - [Workarounds](#workarounds) + - [warpSize](#warpsize) + - [Textures and Cache Control](#textures-and-cache-control) + - [More Tips](#more-tips) + - [hcc CPU Mode](#hcc-cpu-mode) + - [HIPTRACE Mode](#hiptrace-mode) + - [Environment Variables](#environment-variables) + - [Debugging hipcc](#debugging-hipcc) + - [What Does This Error Mean?](#what-does-this-error-mean) + - [/usr/include/c++/v1/memory:5172:15: error: call to implicitly deleted default constructor of 'std::__1::bad_weak_ptr' throw bad_weak_ptr();](#usrincludecv1memory517215-error-call-to-implicitly-deleted-default-constructor-of-std__1bad_weak_ptr-throw-bad_weak_ptr) + - [grid_launch kernel dispatch - fallback](#grid_launch-kernel-dispatch---fallback) + - [HIP Environment Variables](#hip-environment-variables) + - [Editor Highlighting](#editor-highlighting) + + + # HIP Porting Guide In addition to providing a portable C++ programmming environement for GPUs, HIP is designed to ease the porting of existing CUDA code into the HIP environment. This section describes the available tools diff --git a/docs/markdown/hip_terms.md b/docs/markdown/hip_terms.md index 4ab04f459a..c1a40e0573 100644 --- a/docs/markdown/hip_terms.md +++ b/docs/markdown/hip_terms.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Table Comparing Syntax for Different Compute APIs](#table-comparing-syntax-for-different-compute-apis) + + + # Table Comparing Syntax for Different Compute APIs |Term|CUDA|HIP|HC|C++AMP|OpenCL| diff --git a/docs/markdown/hip_terms2.md b/docs/markdown/hip_terms2.md index 53097d0e88..6807338b8d 100644 --- a/docs/markdown/hip_terms2.md +++ b/docs/markdown/hip_terms2.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Terms used in HIP Documentation](#terms-used-in-hip-documentation) + + + # Terms used in HIP Documentation