This is an archive of the discontinued LLVM Phabricator instance.

Differential D111685

[Polly][NFC] Clean up Polly's getting started docs
ClosedPublic

Authored by InnovativeInventor on Oct 12 2021, 4:07 PM.

Details

Reviewers
Meinersbur
bollu
InnovativeInventor
Commits
rG5f668bba5574: [Polly] Clean up Polly's getting started docs.
Summary

This patch removes the broken bash scipt (polly.sh) and fixes the broken setup
instructions in get_started.html. It also adds instructions for using Ninja and
links to the LLVM getting started page.

Diff Detail

Event Timeline

InnovativeInventor created this revision.Oct 12 2021, 4:07 PM
Herald added a reviewer: bollu. · View Herald TranscriptOct 12 2021, 4:07 PM
InnovativeInventor requested review of this revision.Oct 12 2021, 4:07 PM
Herald added a project: Restricted Project. · View Herald TranscriptOct 12 2021, 4:07 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
InnovativeInventor added a project: Restricted Project.Oct 12 2021, 4:09 PM
InnovativeInventor retitled this revision from [polly][NFC] Clean up Polly's getting started docs to [Polly][NFC] Clean up Polly's getting started docs.
InnovativeInventor edited reviewers, added: Meinersbur; removed: bollu.
InnovativeInventor added a subscriber: pollydev.
Herald added a reviewer: bollu. · View Herald TranscriptOct 12 2021, 4:10 PM
Harbormaster completed remote builds in B128498: Diff 379218.Oct 12 2021, 4:25 PM
Meinersbur added a comment.Oct 12 2021, 4:38 PM

Thanks for the patch!

Could also add an example invocation on how to use Polly after compiling, such as bin/clang -O3 -mllvm -polly hello.c?

For consistency with the rest of the documentation (from the doc/), it would be nicer to have it generated with Sphinx, but I don't require it.

polly/www/get_started.html
17

Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and ninja (cmake -GNinja), CMake and make (cmake -G"Unix Makefiles"), or most other generators supported by CMake, such as XCode, Visual Studio.

18

I myself am using Visual Studio

28

Did you try this? How much disk space does it save?

31

This will create a debug build which may use a lot of memory to build and is slow. For starters, I'd recommend a Release+Assert build unless one starts using a debugger (or wants accurate line numbers in crash traces). I.e. -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON.

What do you think?

39–44

If we want to be generator-agnostic, we can also use cmake --build . --target check-polly

40

Why this line again? Once configured with CMake, there is no need to configure again.

InnovativeInventor updated this revision to Diff 379243.Oct 12 2021, 6:29 PM
InnovativeInventor marked 4 inline comments as done.

Add Polly invocation instructions and resolve cmake/ninja confusion

Harbormaster completed remote builds in B128513: Diff 379243.Oct 12 2021, 6:29 PM
InnovativeInventor marked 2 inline comments as done.Oct 12 2021, 6:30 PM
InnovativeInventor added inline comments.
polly/www/get_started.html
17

Oh, whoops. Just fixed this -- thanks for clarifiying!

28

It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes about 1.5 GB (so ~53% reduction).

31

Sounds good -- just added it.

Meinersbur requested changes to this revision.Oct 12 2021, 7:40 PM

You uploaded a diff to your previous diff. Please upload a diff to LLVM's top-of-tree.

polly/www/get_started.html
13

Why remove the menu?

67

This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.html, but I don't think this is relevant for a getting_started.

This revision now requires changes to proceed.Oct 12 2021, 7:40 PM
InnovativeInventor updated this revision to Diff 379498.Oct 13 2021, 12:39 PM
InnovativeInventor marked an inline comment as done.

I added a proper diff (I think) and added back the mistakenly removed menu that I didn't intend to commit.

Harbormaster completed remote builds in B128701: Diff 379498.Oct 13 2021, 1:09 PM
Meinersbur accepted this revision.Oct 13 2021, 1:22 PM

LGTM. Thanks for the patch.

Would you like me to land the patch for you?

This revision is now accepted and ready to land.Oct 13 2021, 1:22 PM
InnovativeInventor accepted this revision.Oct 13 2021, 1:47 PM
InnovativeInventor marked an inline comment as done.

Yes, thanks!

Closed by commit rG5f668bba5574: [Polly] Clean up Polly's getting started docs. (authored by Meinersbur). · Explain WhyOct 14 2021, 10:28 AM
This revision was automatically updated to reflect the committed changes.
Meinersbur added a commit: rG5f668bba5574: [Polly] Clean up Polly's getting started docs..
Meinersbur added a comment.Oct 14 2021, 10:29 AM

Thanks for your contribution! I removed the [NFC] tag before committing since there isn't really behavioral change for documentation.

Revision Contents

PathSize
polly/
www/
38 lines

Diff 379243

polly/www/get_started.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd"> "http://www.w3.org/TR/html4/strict.dtd">
<html> <html>
<head> <head>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Polly - Getting Started</title> <title>Polly - Getting Started</title>
<link type="text/css" rel="stylesheet" href="menu.css" /> <link type="text/css" rel="stylesheet" href="menu.css" />
<link type="text/css" rel="stylesheet" href="content.css" /> <link type="text/css" rel="stylesheet" href="content.css" />
</head> </head>
<body> <body>
<div id="box"> <div id="box">
<!--#include virtual="menu.html.incl"-->
MeinersburUnsubmitted
Not Done
ReplyInline Actions

Why remove the menu?

Meinersbur: Why remove the menu?
<div id="content"> <div id="content">
<h1>Building and Installing Polly</h1> <h1>Building and Installing Polly</h1>
You can build Polly with <a href="https://ninja-build.org/">Ninja</a> or <a href="https://cmake.org/">cmake</a>. You can build Polly with <a href="https://cmake.org/">cmake</a> and your preferred geneator (e.g. Ninja, make, Visual Studio, etc.).
MeinersburUnsubmitted
Done
ReplyInline Actions

Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and ninja (cmake -GNinja), CMake and make (cmake -G"Unix Makefiles"), or most other generators supported by CMake, such as XCode, Visual Studio.

Meinersbur: Ninja and CMake are not alternatives of each other. Your can build LLVM with either CMake and…
InnovativeInventorAuthorUnsubmitted
Done
ReplyInline Actions

Oh, whoops. Just fixed this -- thanks for clarifiying!

InnovativeInventor: Oh, whoops. Just fixed this -- thanks for clarifiying!
Other generators build systems can also be used, but are not supported.
MeinersburUnsubmitted
Done
ReplyInline Actions

I myself am using Visual Studio

Meinersbur: I myself am using Visual Studio
<h3 id="source"> Get the code </h3> <h3 id="source">Get the code</h3>
<pre> <pre>
git clone https://github.com/llvm/llvm-project.git git clone https://github.com/llvm/llvm-project.git
</pre> </pre>
You can also get a shallow clone by running: You can also get a shallow clone by running:
<pre> <pre>
git clone --depth 1 https://github.com/llvm/llvm-project.git git clone --depth 1 https://github.com/llvm/llvm-project.git
MeinersburUnsubmitted
Done
ReplyInline Actions

Did you try this? How much disk space does it save?

Meinersbur: Did you try this? How much disk space does it save?
InnovativeInventorAuthorUnsubmitted
Done
ReplyInline Actions

It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes about 1.5 GB (so ~53% reduction).

InnovativeInventor: It saves a non-trivial amount. A full clone takes about 3.2 GB, whereas a shallow clone takes…
</pre> </pre>
<h3 id="build">Build Polly (with Ninja)</h3> <h3 id="build">Build Polly</h3>
MeinersburUnsubmitted
Done
ReplyInline Actions

This will create a debug build which may use a lot of memory to build and is slow. For starters, I'd recommend a Release+Assert build unless one starts using a debugger (or wants accurate line numbers in crash traces). I.e. -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON.

What do you think?

Meinersbur: This will create a debug build which may use a lot of memory to build and is slow. For starters…
InnovativeInventorAuthorUnsubmitted
Done
ReplyInline Actions

Sounds good -- just added it.

InnovativeInventor: Sounds good -- just added it.
<pre>
mkdir build && cd build
cmake -G Ninja '-DLLVM_ENABLE_PROJECTS=clang;polly' ../llvm
ninja
</pre>
<h3 id="build">Build Polly (with cmake)</h3>
<pre> <pre>
mkdir build && cd build mkdir build && cd build
cmake '-DLLVM_ENABLE_PROJECTS=clang;polly' ../llvm cmake '-DLLVM_ENABLE_PROJECTS=clang;polly' ../llvm
cmake --build . cmake --build .
</pre> </pre>
<h3> Test Polly (with Ninja)</h3> You can also pass arguments to cmake to specify a particular generator (e.g. <code>-G Ninja</code>) or the build type (<code>-DCMAKE_BUILD_TYPE=Release</code>).
MeinersburUnsubmitted
Done
ReplyInline Actions

Why this line again? Once configured with CMake, there is no need to configure again.

Meinersbur: Why this line again? Once configured with CMake, there is no need to configure again.
If you just want to play around with Polly, it is recommended to do a Release+Assert build by passing
<code>-DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON</code>.
<h3>Test Polly</h3>
MeinersburUnsubmitted
Done
ReplyInline Actions
<h3> Test Polly (with Ninja)</h3>
- <pre>ninja check Polly</pre>
+ <pre>ninja check-polly</pre>
<h3> Troubleshooting</h3>

If we want to be generator-agnostic, we can also use cmake --build . --target check-polly

Meinersbur: If we want to be generator-agnostic, we can also use `cmake --build . --target check-polly`
<pre>ninja check Polly</pre> <pre>cmake --build . --target check-polly</pre>
<h3>Using Polly</h3>
Suppose that you want to compile a program hello.c using Polly.
To compile it with Polly (in the build folder), you can run:
<pre>
bin/clang -O3 -mllvm -polly hello.c
</pre>
<h3> Troubleshooting</h3> <h3> Troubleshooting</h3>
<p> <p>
If you run out of memory when building, lower the concurrency of Ninja (e.g. <code> ninja -j 2 </code>). If you run out of memory when building with Ninja, try lowering the concurrency of Ninja (e.g. <code> ninja -j 2 </code>).
More tips and tricks to building and using LLVM can be found <a href="https://llvm.org/docs/GettingStarted.html#common-problems">here</a>. More tips and tricks to building and using LLVM can be found <a href="https://llvm.org/docs/GettingStarted.html#common-problems">here</a>.
</p> </p>
<p> <p>
For more information on getting started with Polly and LLVM in general, see LLVM's <a href = "https://llvm.org/docs/GettingStarted.html">getting started docs</a>. For more information on getting started with Polly and LLVM in general, see LLVM's <a href = "https://llvm.org/docs/GettingStarted.html">getting started docs</a>.
You can also read the release notes <a href="https://releases.llvm.org/12.0.1/tools/polly/docs/index.html">here</a>.
MeinersburUnsubmitted
Done
ReplyInline Actions

This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.html, but I don't think this is relevant for a getting_started.

Meinersbur: This is already out-of date. Latest release note is https://polly.llvm.org/docs/ReleaseNotes.
</p> </p>
</div> </div>
</div> </div>
</body> </body>
</html> </html>