37 Commits

Author SHA1 Message Date
Kazu Hirata
11e2975810 Fx typos in documentation 2023-08-18 23:36:04 -07:00
Fangrui Song
26182dfa36 [docs] Replace deprecated -target with --target= 2023-02-05 16:34:22 -08:00
KAWASHIMA Takahiro
799b6b9f31 [clang][docs] Use option directive in User's Manual
Sphinx has the `option` directive. Most option descriptions
in `clang/docs/UsersManual.rst` used it but some didn't.
This commit changes the remaining option descriptions to use
the `option` directive. This makes a consistent view in HTML.

The `option` directive automatically creates a cross-reference target.
So labeling by `.. _opt_XXX:` is almost unnecessary. However, options
with and without `no-` (e.g. `-fno-show-column`/`-fshow-column`)
cannot be distinguish for the cross-reference. So some required
`.. _opt_XXX:` directives are kept unremoved.

Differential Revision: https://reviews.llvm.org/D138088
2022-11-22 10:40:54 +09:00
tlattner
eb1ffd817c Update references to Discourse instead of the mailing lists.
Update the references to the old Mailman mailing lists to point to Discourse forums.

Reviewed By: aaron.ballman

Differential Revision: https://reviews.llvm.org/D128766
2022-07-08 11:16:47 -07:00
Anastasia Stulova
7df25978ef [Doc][OpenCL] Misc wording improvements for SPIR-V 2022-05-27 11:13:06 +01:00
Anastasia Stulova
3087afb421 [OpenCL][Doc] Misc improvements related to SPIR-V support. 2022-05-26 15:54:33 +01:00
Anastasia Stulova
d61ded1034 [OpenCL] Make -cl-ext a driver option.
For generic targets such as SPIR-V clang sets all OpenCL
extensions/features as supported by default. However
concrete targets are unlikely to support all extensions
features, which creates a problem when such generic SPIR-V
binary is compiled for a specific target later on.

To allow compile time diagnostics for unsupported features
this flag is now being exposed in the clang driver.

Differential Revision: https://reviews.llvm.org/D125243
2022-05-24 11:34:19 +01:00
Anastasia Stulova
fdd615d4f9 [Docs][OpenCL] Update OpenCL 3.0 status in docs.
Reflect the latest development in clang docs.

Differential Revision: https://reviews.llvm.org/D119719
2022-02-16 12:32:20 +00:00
Sven van Haastregt
a464444b28 [OpenCL][Docs] Update OpenCL 3.0 status info
Update the table to reflect recently committed work.
2022-02-09 15:12:49 +00:00
Anastasia Stulova
30ad1742c0 [Docs] Document C++ for OpenCL 2021 support in clang.
Along with the new language mode this commit contains misc
small updates for OpenCL 3 and GitHub issues for OpenCL.

Differential Revision: https://reviews.llvm.org/D116271
2022-01-04 11:18:15 +00:00
Shao-Ce SUN
0c660256eb [NFC] Trim trailing whitespace in *.rst 2021-11-15 09:17:08 +08:00
Anastasia Stulova
fbe00c6874 [OpenCL][Docs] Update OpenCL 3.0 status info.
Update info on OpenCLSupport page to reflect changes
committed after release 13 branched.
2021-09-10 13:07:07 +01:00
Anastasia Stulova
9685631cbe [OpenCL][Docs] Added ref to libclcxx
Linked libclcxx GitHub project page in C++ libraries
for OpenCL section on OpenCLSupport page.

Differential Revision: https://reviews.llvm.org/D109526
2021-09-10 12:29:11 +01:00
Anastasia Stulova
cff03d5fc4 [OpenCL][Docs] Update OpenCL 3.0 implementation status.
Update a section of OpenCLSupport page to reflect the latest
development in OpenCL 3.0 support for release 13.

Differential Revision: https://reviews.llvm.org/D109320
2021-09-10 12:17:11 +01:00
Sven van Haastregt
22fdf617b6 [OpenCL][Docs] Adding builtins requires adding to both now
As we are trying to reach parity between opencl-c.h and
-fdeclare-opencl-builtins, ensure the documentation mentions that new
builtins should be added to both.

Reviewed by: Anastasia Stulova
2021-08-06 10:21:26 +01:00
Aaron Ballman
96ef4f4a24 Hopefully fix the Clang sphinx doc build.
This was broken several days ago in 826905787ae4c8540bb8a2384fac59c606c7eaff.
2021-05-27 10:27:01 -04:00
Anastasia Stulova
5ccc79dc38 [OpenCL][Docs] Minor update to OpenCL 3.0 2021-05-24 14:19:22 +01:00
Anton Zabaznov
826905787a [OpenCL] Add support of OpenCL C 3.0 __opencl_c_fp64
There already exists cl_khr_fp64 extension. So OpenCL C 3.0
and higher should use the feature, earlier versions still
use the extension. OpenCL C 3.0 API spec states that extension
will be not described in the option string if corresponding
optional functionality is not supported (see 4.2. Querying Devices).
Due to that fact the usage of features for OpenCL C 3.0 must
be as follows:

```
$ clang -Xclang -cl-ext=+cl_khr_fp64,+__opencl_c_fp64 ...

$ clang -Xclang -cl-ext=-cl_khr_fp64,-__opencl_c_fp64 ...
```

e.g. the feature and the equivalent extension (if exists)
must be set to the same values

Reviewed By: Anastasia

Differential Revision: https://reviews.llvm.org/D96524
2021-05-21 15:01:19 +03:00
Ole Strohm
f372ff17f7 [NFC] (test commit) Changed example invocation of C++ for OpenCL 2021-05-07 12:31:37 +01:00
Anastasia Stulova
1ed6e87ab0 [OpenCL][Docs] Misc updates to C++ for OpenCL and offline compilation
Differential Revision: https://reviews.llvm.org/D101092
2021-04-29 14:15:07 +01:00
Sven van Haastregt
856c49d79c [OpenCL][Docs] Update OpenCL 3.0 implementation status
Reviewed-By: Anastasia Stulova
2021-04-14 13:56:26 +01:00
Anastasia Stulova
6e8601ff4a [OpenCL][Docs] Fix typo in section label 2021-04-08 10:59:44 +01:00
Anastasia Stulova
d4e9fe813f [OpenCL][Docs] Update links to the C++ for OpenCL documentation 2021-04-01 20:38:24 +01:00
Anastasia Stulova
7c541a195f [OpenCL][Docs] Added a label for C++ libs section and example link 2021-04-01 13:55:23 +01:00
Anastasia Stulova
a81925664b [OpenCL][Docs] Update status of OpenCL 3.0 development 2021-03-26 13:07:06 +00:00
Anastasia Stulova
bafcb4c684 [OpenCL][Docs] Add guidelines for new extensions and features.
Add documentation that explains how to extend clang with the new
extensions/features. The guidelines also detail clang's position
about the extension pragmas for the new functionality.

Differential Revision: https://reviews.llvm.org/D97072
2021-03-11 14:28:48 +00:00
Anastasia Stulova
90355d6f10 [OpenCL][Docs] Change description for the OpenCL standard headers.
After updating the user interface in D96515, update the docs
reflecting the new approach.

Tags: #clang

Differential Revision: https://reviews.llvm.org/D96616
2021-02-23 11:49:05 +00:00
Sven van Haastregt
18f16c945f [OpenCL][Docs] Clean up trailing characters
Clean up trailing whitespace and a stray backtick.
2021-02-12 09:58:18 +00:00
Sven van Haastregt
18a70797e7 [OpenCL][Docs] Describe internals of TableGen builtins
Add a high level explanation of the `-fdeclare-opencl-builtins` option.

Differential Revision: https://reviews.llvm.org/D96150
2021-02-12 09:56:32 +00:00
Anastasia Stulova
7a45f27ba1 [OpenCL][Docs] Fix command line flag in the example.
Fixed incorrect example of clang command line with
the builtin function declarations in OpenCLSupport.

Tags: #clang
2021-02-03 14:07:46 +00:00
Anastasia Stulova
d7cc3a083f [OpenCL][Docs] Moved info from UsersManual into OpenCLSupport.
Moved information detailing the implementation from UsersManual
into OpenCLSupport page as it is not relevant to the user's of
clang but primarily needed for the compiler developers.

Tags: #clang

Differential Revision: https://reviews.llvm.org/D95061
2021-01-27 12:21:22 +00:00
Anastasia Stulova
8fdd5784f0 [OpenCL][Docs] Describe tablegen BIFs declarations.
Added documentation for the fast builtin
function declarations with -fdeclare-opencl-builtins.

Tags: #clang

Differential Revision: https://reviews.llvm.org/D95038
2021-01-25 11:17:03 +00:00
Anastasia Stulova
bc84f89c71 [OpenCL][Docs] Fixed cross-section reference in OpenCLSupport
Tags: #clang
2021-01-15 17:20:13 +00:00
Anastasia Stulova
d1862a1631 [OpenCL][Docs] Fixed malformed table in OpenCLSupport
Tags: #clang
2021-01-15 14:27:26 +00:00
Anastasia Stulova
adb77a7456 [OpenCL] Improve online documentation.
Update UsersManual and OpenCLSupport pages to reflect
recent functionality i.e. SPIR-V generation,
C++ for OpenCL, OpenCL 3.0 development plans.

Tags: #clang

Differential Revision: https://reviews.llvm.org/D93942
2021-01-14 14:56:10 +00:00
Anastasia Stulova
0ef2b68ff0 [OpenCL] Documentation for experimental C++ libs
Started a new doc section about the OpenCL experimental
features and described ongoing work on C++ libraries
e.g. type traits.

Tags: #clang

Differential Revision: https://reviews.llvm.org/D94188
2021-01-08 13:45:59 +00:00
Sven van Haastregt
5e962e8d7d [OpenCL] Add doc to describe OpenCL support
The idea of this page is to document work in progress functionality
and also describe the plan of future development work.

Patch by Anastasia Stulova.

Differential Revision: https://reviews.llvm.org/D69072

llvm-svn: 375111
2019-10-17 12:56:02 +00:00