Skip to content

Commit 2f302ec

Browse files
svenvhAlexeySachkov
authored andcommitted
README.md: Update branches section
Remove any remaining references to LLVM SVN/trunk and update any links that were still pointing to the old LLVM split repository mirrors. Elaborate on tags and how they match up with LLVM. Line-wrap the affected paragraphs to 80 characters.
1 parent 2eaa1cb commit 2f302ec

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

llvm-spirv/README.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ The files/directories related to the translator:
1818

1919
## Build Instructions
2020

21-
The `master` branch of this repo is aimed to be buildable with the latest LLVM `master` or `trunk` revision.
21+
The `master` branch of this repo is aimed to be buildable with the latest
22+
LLVM `master` revision.
2223

2324
### Build with pre-installed LLVM
2425

@@ -163,8 +164,25 @@ More information can be found in
163164
164165
## Branching strategy
165166
166-
Code on the master branch in this repository is intended to be compatible with master/trunk branch of the [llvm](https://github.com/llvm-mirror/llvm) project. That is, for an OpenCL kernel compiled to llvm bitcode by the latest version(built with the latest git commit or svn revision) of Clang it should be possible to translate it to SPIR-V with the llvm-spirv tool.
167+
Code on the master branch in this repository is intended to be compatible with
168+
the master branch of the [llvm](https://github.com/llvm/llvm-project)
169+
project. That is, for an OpenCL kernel compiled to llvm bitcode by the latest
170+
git revision of Clang it should be possible to translate it to SPIR-V with the
171+
llvm-spirv tool.
167172
168173
All new development should be done on the master branch.
169174
170-
To have versions compatible with released versions of LLVM and Clang, corresponding branches are available in this repository. For example, to build the translator with LLVM 7.0 ([release_70](https://github.com/llvm-mirror/llvm/tree/release_70)) one should use the [llvm_release_70](https://github.com/KhronosGroup/SPIRV-LLVM-Translator/tree/llvm_release_70) branch. As a general rule, commits from the master branch may be backported to the release branches as long as they do not depend on features from a later LLVM/Clang release and there are no objections from the maintainer(s). There is no guarantee that older release branches are proactively kept up to date with master, but you can request certain commits on older release branches by creating a pull request or raising an issue on GitHub.
175+
To have versions compatible with released versions of LLVM and Clang,
176+
corresponding tags are available in this repository. For example, to build
177+
the translator with
178+
[LLVM 7.0.0](https://github.com/llvm/llvm-project/tree/llvmorg-7.0.0)
179+
one should use the
180+
[v7.0.0-1](https://github.com/KhronosGroup/SPIRV-LLVM-Translator/tree/v7.0.0-1)
181+
tag. The 7.x releases are maintained on the
182+
[llvm_release_70](https://github.com/KhronosGroup/SPIRV-LLVM-Translator/tree/llvm_release_70)
183+
branch. As a general rule, commits from the master branch may be backported to
184+
the release branches as long as they do not depend on features from a later
185+
LLVM/Clang release and there are no objections from the maintainer(s). There
186+
is no guarantee that older release branches are proactively kept up to date
187+
with master, but you can request specific commits on older release branches by
188+
creating a pull request or raising an issue on GitHub.

0 commit comments

Comments
 (0)