11# Instructions for updating to the latest LLVM/Clang sources
22
33We are staying in sync with the upstream LLVM/Clang repository. The ` baseline `
4- branch of the ` checkedc-clang ` repository is a pristine copy of LLVM/Clang
4+ branch of the ` checkedc-llvm-project ` repository is a pristine copy of LLVM/Clang
55sources, and the ` master ` branch contains LLVM/Clang sources plus the support
66for Checked C language extensions. We periodically upgrade the ` baseline ` branch
77and the ` master ` branch to the sources of the most recent releases from the
88upstream LLVM/Clang repository.
99
10- The branching and merging policies of the ` checkedc-clang ` repository are
10+ The branching and merging policies of the ` checkedc-llvm-project ` repository are
1111aligned with the versioning and branching of upstream LLVM/Clang repository in
1212order to closely follow the LLVM/Clang releases. LLVM/Clang releases are
1313versioned as < ; major-version> ; .< ; minor-version> ; .< ; patch-version> ; .
@@ -19,13 +19,13 @@ is created. Bug fixes go on the release branch and only some of these bug fixes
1919get merged back into the ` main ` branch. Typically, LLVM/Clang makes two final
2020releases for each major version.
2121
22- Now we describe our approach for upgrading the ` checkedc-clang ` repository to
22+ Now we describe our approach for upgrading the ` checkedc-llvm-project ` repository to
2323LLVM/Clang sources corresponding to the two releases for each major version,
2424for example, 12.0.0 and 12.0.1. The upgrade is performed in two phases as
2525described below. This description is followed by detailed instructions for each
2626phase.
2727
28- ** Phase 1** : We upgrade the ` master ` branch of the ` checkedc-clang ` repository
28+ ** Phase 1** : We upgrade the ` master ` branch of the ` checkedc-llvm-project ` repository
2929up to the commit hash on the ` main ` branch of the LLVM/Clang repository at which
3030the branch ` release/12.x ` is created - we shall refer to this commit hash as
3131< ; branch-point-of-12-on-main> ; . We get this commit hash by executing the
@@ -35,10 +35,10 @@ needs to be the full commit hash and not just the 7-digit abbreviation. This
3535phase constitutes the major portion of the developer effort towards the merge.
3636
3737** Phase 2** : We create a branch called ` release_12.x ` off the ` master ` branch in
38- the ` checkedc-clang ` repository. Then there are two sub-phases:
38+ the ` checkedc-llvm-project ` repository. Then there are two sub-phases:
3939 - When we wish to make a Checked C compiler release based on the 12.0.0
4040 release of LLVM/Clang:
41- - We first upgrade the ` release_12.x ` branch (of the ` checkedc-clang `
41+ - We first upgrade the ` release_12.x ` branch (of the ` checkedc-llvm-project `
4242 repository) to the sources corresponding to the 12.0.0 release on the
4343 ` release/12.x ` branch of the LLVM/Clang repository.
4444 - Next, we merge Checked C features and bug fixes from the ` master ` branch
@@ -47,7 +47,7 @@ the `checkedc-clang` repository. Then there are two sub-phases:
4747 branch.
4848 - When we wish to make a Checked C compiler release based on the 12.0.1
4949 release of LLVM/Clang:
50- - We upgrade the same ` release_12.x ` branch (of the ` checkedc-clang `
50+ - We upgrade the same ` release_12.x ` branch (of the ` checkedc-llvm-project `
5151 repository) to the sources corresponding to the 12.0.1 release on the
5252 ` release/12.x ` branch of the LLVM/Clang repository.
5353 - Next, we merge Checked C features and bug fixes from the ` master ` branch
@@ -66,7 +66,7 @@ be interspersed with Checked C development on the `master` branch.
6666
6767## Detailed Instructions - Phase 1
6868
69- 1 . Create a new branch off the ` baseline ` branch in the ` checkedc-clang `
69+ 1 . Create a new branch off the ` baseline ` branch in the ` checkedc-llvm-project `
7070repository. Let us call this new branch ` updated_baseline ` .
7171```
7272 git checkout -b updated_baseline baseline
@@ -92,7 +92,7 @@ branch.
9292```
9393 git checkout -b updated_baseline_master_12 baseline
9494```
95- 6 . Merge the ` master ` branch of the checkedc-clang repository into the
95+ 6 . Merge the ` master ` branch of the checkedc-llvm-project repository into the
9696` updated_baseline_master_12 ` branch. This merge may cause several merge
9797conflicts and test case failures. After the merge command, git may suggest to
9898you to set ` merge.renamelimit ` to a specific value. It is a good idea to set it
@@ -144,7 +144,7 @@ We give the instructions for the first sub-phase of Phase 2. Similar steps
144144have to be followed for the other sub-phase.
145145
1461461 . Create a new branch, called ` release_12.x ` , from the ` master ` branch in the
147- ` checkedc-clang ` repository. If the branch already exists, then merge the
147+ ` checkedc-llvm-project ` repository. If the branch already exists, then merge the
148148` master ` branch into it. Resolve merge conflicts and test failures if any.
149149```
150150 git checkout -b release_12.x master
@@ -209,7 +209,7 @@ on GitHub. Just push the branches up to GitHub.
2092092 . While resolving merge conflicts, it is a good idea to have three reference
210210code snapshots to perform diffs of individual files to help distinguish between
211211checkedc-specific changes and llvm-11-to-12 changes:
212- - The ` master ` branch of the ` checkedc-clang ` repository at the commit hash
212+ - The ` master ` branch of the ` checkedc-llvm-project ` repository at the commit hash
213213 which was merged into ` updated_baseline_master_12 ` .
214214 - The pristine LLVM/Clang source at < ; branch-point-of-11-on-main> ;
215215 - The pristine LLVM/Clang source at < ; branch-point-of-12-on-main> ;
0 commit comments