Skip to content

Commit 4e6d682

Browse files
author
Mandeep Singh Grang
committed
Update README with monorepo instructions
1 parent d228605 commit 4e6d682

File tree

1 file changed

+73
-29
lines changed

1 file changed

+73
-29
lines changed

‎README.md

Lines changed: 73 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,76 @@
1-
21
# The Checked C clang repo
32

4-
This repo contains a version of clang that is being modified to support Checked C. Checked C
5-
extends C with checking to detect or prevent common programming errors such as
6-
out-of-bounds memory accesses. The Checked C specification is available at the
3+
This repo contains a version of the LLVM/Clang toolchain that is being modified
4+
to support Checked C. Checked C extends C with checking to detect or prevent
5+
common programming errors such as out-of-bounds memory accesses. The Checked
6+
C specification is available at the
77
[Checked C repo](https://github.com/Microsoft/checkedc).
88

9+
## Announcement
10+
11+
Earlier this year, the LLVM community
12+
[transitioned](https://forums.swift.org/t/llvm-monorepo-transition/25689) to
13+
"monorepo". To align with upstream, we are now planning to transition CheckedC
14+
to a monorepo.
15+
16+
Starting first week of Oct 2019, the checkedc-clang project will transition to
17+
monorepo. This would result in the following changes:
18+
19+
1. [checkedc-llvm](https://github.com/Microsoft/checkedc-llvm) and
20+
[checkedc-clang](https://github.com/Microsoft/checkedc-clang) (as well as other
21+
LLVM subprojects) would be tracked via a single git repo.
22+
23+
2. The [checkedc-llvm](https://github.com/Microsoft/checkedc-llvm) repo would
24+
no longer be maintained. The
25+
[checkedc-clang](https://github.com/Microsoft/checkedc-clang) repo would be the
26+
new monorepo.
27+
28+
3. There would be no changes to the
29+
[checkedc](https://github.com/Microsoft/checkedc) repo. It would continue to be
30+
a separate git repo.
31+
32+
4. All future patches should be based off this new monorepo.
33+
34+
5. You can use
35+
[this](https://github.com/microsoft/checkedc-clang/blob/monorepo/clang/automation/UNIX/cherry-pick-to-monorepo.sh)
36+
script to cherry-pick your existing patches to the new monorepo.
37+
38+
6. Make sure to set the following CMake flag to enable clang in your builds:
39+
`-DLLVM_ENABLE_PROJECTS=clang`
40+
941
## Compiler source code update
1042

11-
On January 25, 2019, we updated to LLVM/clang sources from January 16, 2019. If you are building the Checked C clang compiler
12-
from source code, we suggest you do a clean build by deleting your cmake object directory.
43+
On January 25, 2019, we updated to LLVM/Clang sources from January 16, 2019.
44+
If you are building the Checked C clang compiler from source code, we suggest
45+
you do a clean build by deleting your cmake object directory.
1346

1447
## We are hiring.
1548

16-
We have a position available for a
17-
[Principal Software Engineer](https://careers.microsoft.com/us/en/job/559081/Principal-Software-Engineer) or a
18-
[Senior Software Engineer](https://careers.microsoft.com/us/en/job/570339/Senior-Software-Engineer). We are looking for someone wih compiler and programming language implementation experience who is passionate about making software more secure and reliable.
49+
We have a position available for a [Principal Software
50+
Engineer](https://careers.microsoft.com/us/en/job/559081/Principal-Software-Engineer)
51+
or a [Senior Software
52+
Engineer](https://careers.microsoft.com/us/en/job/570339/Senior-Software-Engineer).
53+
We are looking for someone wih compiler and programming language implementation
54+
experience who is passionate about making software more secure and reliable.
1955

2056
## Trying out Checked C
2157

22-
Programmers are welcome to ``kick the tires'' on Checked C as it is being implemented.
23-
We have pre-built compiler installers for Windows available for download on the
24-
[release page](https://github.com/Microsoft/checkedc-clang/releases).
25-
For other platforms, you will have to build your own copy of the compiler. For directions on how to do this, see
26-
the [Checked C clang wiki](https://github.com/Microsoft/checkedc-clang/wiki). The compiler user manual is [here](https://github.com/Microsoft/checkedc-clang/wiki/Checked-C-clang-user-manual).
27-
For more information on Checked C and pointers to example code, see our [Wiki](https://github.com/Microsoft/checkedc/wiki).
58+
Programmers are welcome to "kick the tires" on Checked C as it is being
59+
implemented. We have pre-built compiler installers for Windows available for
60+
download on the [release
61+
page](https://github.com/Microsoft/checkedc-clang/releases). For other
62+
platforms, you will have to build your own copy of the compiler. For
63+
directions on how to do this, see the [Checked C clang
64+
wiki](https://github.com/Microsoft/checkedc-clang/wiki). The compiler user
65+
manual is
66+
[here](https://github.com/Microsoft/checkedc-clang/wiki/Checked-C-clang-user-manual).
67+
For more information on Checked C and pointers to example code, see our
68+
[Wiki](https://github.com/Microsoft/checkedc/wiki).
2869

2970
## More information
3071

31-
For more information on the Checked C clang compiler, see the [Checked C clang wiki](https://github.com/Microsoft/checkedc-clang/wiki).
72+
For more information on the Checked C clang compiler, see the [Checked C clang
73+
wiki](https://github.com/Microsoft/checkedc-clang/wiki).
3274

3375
## Build Status
3476

@@ -41,20 +83,22 @@ For more information on the Checked C clang compiler, see the [Checked C clang w
4183

4284
## Contributing
4385

44-
We welcome contributions to the Checked C project. To get involved in the project, see
45-
[Contributing to Checked C](https://github.com/Microsoft/checkedc/blob/master/CONTRIBUTING.md). We have
46-
a wish list of possible projects there.
86+
We welcome contributions to the Checked C project. To get involved in the
87+
project, see [Contributing to Checked
88+
C](https://github.com/Microsoft/checkedc/blob/master/CONTRIBUTING.md). We
89+
have a wish list of possible projects there.
4790

48-
For code contributions, we follow the standard
49-
[Github workflow](https://guides.github.com/introduction/flow/). See
50-
[Contributing to Checked C](https://github.com/Microsoft/checkedc/blob/master/CONTRIBUTING.md) for more detail.
51-
You will need to sign a contributor license agreement before contributing code.
91+
For code contributions, we follow the standard [Github
92+
workflow](https://guides.github.com/introduction/flow/). See [Contributing to
93+
Checked C](https://github.com/Microsoft/checkedc/blob/master/CONTRIBUTING.md)
94+
for more detail. You will need to sign a contributor license agreement before
95+
contributing code.
5296

5397
## Code of conduct
5498

55-
This project has adopted the
56-
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
57-
For more information see the
58-
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
59-
contact [[email protected]](mailto:[email protected]) with any
60-
additional questions or comments.
99+
This project has adopted the [Microsoft Open Source Code of
100+
Conduct](https://opensource.microsoft.com/codeofconduct/). For more
101+
information see the [Code of Conduct
102+
FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
103+
[[email protected]](mailto:[email protected]) with any additional
104+
questions or comments.

0 commit comments

Comments
 (0)