Skip to content

Commit 002af01

Browse files
committed
[Polly][docs] Polly release notes.
In release 10.0, Polly is not linked into opt/bugpoint/clang by default anymore. Add workarounds in release notes.
1 parent 668b8a4 commit 002af01

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

polly/docs/ReleaseNotes.rst

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,44 @@ In Polly 10 the following important changes have been incorporated.
1010
the new features that have recently been committed to our development
1111
branch.
1212

13-
- Change ...
13+
Statically Linking of Polly
14+
===========================
15+
16+
The mechanism that Polly uses to link itself statically into the opt, bugpoint and clang executables has been generalized such that it can be used by other pass plugins. An example plugin "Bye" has been added to illustate the mechanism. A consequence of this change is that Polly, like the "Bye" plugin, by default is not linked statically into aforementioned executables anymore.
17+
18+
If Polly is not available, the executable will report an unkown argument `-polly`, such as
19+
20+
.. code-block:: console
21+
22+
$ clang -mllvm -polly -x c -
23+
clang (LLVM option parsing): Unknown command line argument '-polly'. Try: 'clang (LLVM option parsing) --help'
24+
clang (LLVM option parsing): Did you mean '--color'?
25+
26+
.. code-block:: console
27+
28+
$ opt -polly
29+
opt: for the -o option: may not occur within a group!
30+
opt: Unknown command line argument '-polly'. Try: 'opt --help'
31+
opt: Did you mean '-o'?
32+
33+
Polly can be made available using the following methods.
34+
35+
- Configure LLVM/Clang with the CMake options LLVM_POLLY_LINK_INTO_TOOLS=ON and LLVM_ENABLE_PROJECTS=polly.
36+
37+
.. code-block:: console
38+
39+
$ cmake -DLLVM_POLLY_LINK_INTO_TOOLS=ON -DLLVM_ENABLE_PROJECTS=clang;polly ...
40+
41+
In future versions, LLVM_POLLY_LINK_INTO_TOOLS=ON will be default again if Polly has been enabled.
42+
43+
- Use the `-load` option to load the Polly module.
44+
45+
.. code-block:: console
46+
47+
$ clang -Xclang -load -Xclang path/to/LLVMPolly.so ...
48+
49+
.. code-block:: console
50+
51+
$ opt -load path/to/LLVMPolly.so ...
52+
53+
The LLVMPolly.so module can be found in the `lib/` directory of the build or install-prefix directory.

0 commit comments

Comments
 (0)