Skip to content

Commit 890e71e

Browse files
author
Pavel Chupin
authored
[SYCL][Doc] Fixing incorrect merge of community Readme.md with our version (#5636)
1 parent 57f8a44 commit 890e71e

File tree

1 file changed

+0
-83
lines changed

1 file changed

+0
-83
lines changed

README.md

Lines changed: 0 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -28,86 +28,3 @@ See [LICENSE.txt](sycl/LICENSE.TXT) for details.
2828
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
2929

3030
*\*Other names and brands may be claimed as the property of others.*
31-
32-
This is an example work-flow and configuration to get and build the LLVM source:
33-
34-
1. Checkout LLVM (including related sub-projects like Clang):
35-
36-
* ``git clone https://github.com/llvm/llvm-project.git``
37-
38-
* Or, on windows, ``git clone --config core.autocrlf=false
39-
https://github.com/llvm/llvm-project.git``
40-
41-
2. Configure and build LLVM and Clang:
42-
43-
* ``cd llvm-project``
44-
45-
* ``cmake -S llvm -B build -G <generator> [options]``
46-
47-
Some common build system generators are:
48-
49-
* ``Ninja`` --- for generating [Ninja](https://ninja-build.org)
50-
build files. Most llvm developers use Ninja.
51-
* ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
52-
* ``Visual Studio`` --- for generating Visual Studio projects and
53-
solutions.
54-
* ``Xcode`` --- for generating Xcode projects.
55-
56-
Some common options:
57-
58-
* ``-DLLVM_ENABLE_PROJECTS='...'`` and ``-DLLVM_ENABLE_RUNTIMES='...'`` ---
59-
semicolon-separated list of the LLVM sub-projects and runtimes you'd like to
60-
additionally build. ``LLVM_ENABLE_PROJECTS`` can include any of: clang,
61-
clang-tools-extra, cross-project-tests, flang, libc, libclc, lld, lldb,
62-
mlir, openmp, polly, or pstl. ``LLVM_ENABLE_RUNTIMES`` can include any of
63-
libcxx, libcxxabi, libunwind, compiler-rt, libc or openmp. Some runtime
64-
projects can be specified either in ``LLVM_ENABLE_PROJECTS`` or in
65-
``LLVM_ENABLE_RUNTIMES``.
66-
67-
For example, to build LLVM, Clang, libcxx, and libcxxabi, use
68-
``-DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_RUNTIMES="libcxx;libcxxabi"``.
69-
70-
* ``-DCMAKE_INSTALL_PREFIX=directory`` --- Specify for *directory* the full
71-
path name of where you want the LLVM tools and libraries to be installed
72-
(default ``/usr/local``). Be careful if you install runtime libraries: if
73-
your system uses those provided by LLVM (like libc++ or libc++abi), you
74-
must not overwrite your system's copy of those libraries, since that
75-
could render your system unusable. In general, using something like
76-
``/usr`` is not advised, but ``/usr/local`` is fine.
77-
78-
* ``-DCMAKE_BUILD_TYPE=type`` --- Valid options for *type* are Debug,
79-
Release, RelWithDebInfo, and MinSizeRel. Default is Debug.
80-
81-
* ``-DLLVM_ENABLE_ASSERTIONS=On`` --- Compile with assertion checks enabled
82-
(default is Yes for Debug builds, No for all other build types).
83-
84-
* ``cmake --build build [-- [options] <target>]`` or your build system specified above
85-
directly.
86-
87-
* The default target (i.e. ``ninja`` or ``make``) will build all of LLVM.
88-
89-
* The ``check-all`` target (i.e. ``ninja check-all``) will run the
90-
regression tests to ensure everything is in working order.
91-
92-
* CMake will generate targets for each tool and library, and most
93-
LLVM sub-projects generate their own ``check-<project>`` target.
94-
95-
* Running a serial build will be **slow**. To improve speed, try running a
96-
parallel build. That's done by default in Ninja; for ``make``, use the option
97-
``-j NNN``, where ``NNN`` is the number of parallel jobs, e.g. the number of
98-
CPUs you have.
99-
100-
* For more information see [CMake](https://llvm.org/docs/CMake.html)
101-
102-
Consult the
103-
[Getting Started with LLVM](https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm)
104-
page for detailed information on configuring and compiling LLVM. You can visit
105-
[Directory Layout](https://llvm.org/docs/GettingStarted.html#directory-layout)
106-
to learn about the layout of the source code tree.
107-
108-
## Getting in touch
109-
110-
Join [LLVM Discourse forums](https://discourse.llvm.org/), [discord chat](https://discord.gg/xS7Z362) or #llvm IRC channel on [OFTC](https://oftc.net/).
111-
112-
The LLVM project has adopted a [code of conduct](https://llvm.org/docs/CodeOfConduct.html) for
113-
participants to all modes of communication within the project.

0 commit comments

Comments
 (0)