doc: update docs to clarify clang16 is needed #1542
Assignees
Labels
good first issue
Good for newcomers
Comments
|
hey ludamad, I'd be happy to check this one out. I think it could be a great place for me to start getting a feel for the project as I explore with it. Just to be clear this is for the documentation for which aspect of the project? |
|
Hey there Tommy. I'm happy for you to take this one on. We'd want to start with the README.md's in circuits and circuits/cpp/barretenberg, as well generally do a pass on anywhere clang is mentioned in the repo and see if it can be updated. |
|
As well, if you're so inclined, you can check out the current docs folder (yarn && yarn build && yarn serve) and see if there's something we can add there |
|
@tommymaher15 Any updates here? Anything you need / need this assigned to someone else? |
ludamad
added a commit
that referenced
this issue
Aug 22, 2023
As per #1542 clang 16 is needed so a proposed solution is to check version in bootstrap.sh --------- Co-authored-by: ludamad <[email protected]>
ludamad
pushed a commit
that referenced
this issue
Aug 30, 2023
For #1542 I have changed all of the documentation mentions of clang15 and I didn't find a good place to include this in the `docs` as it seemed like that documentation had to do with developing using aztec packages instead of doing dev work on the aztec packages repo itself. Outside of documentation would you like to see all of the `bootstrap.sh`, `CMakePresents.json`, and `Dockerfile` changed to clang16 as well @ludamad? Here are some examples of what I am referring to: https://github.com/jtfirek/aztec-packages/blob/e189a78db523abf334b39d4bebad48a317ae46c6/circuits/cpp/barretenberg/sol/bootstrap.sh#L21 https://github.com/jtfirek/aztec-packages/blob/e189a78db523abf334b39d4bebad48a317ae46c6/circuits/cpp/CMakePresets.json#L41 https://github.com/jtfirek/aztec-packages/blob/e189a78db523abf334b39d4bebad48a317ae46c6/circuits/cpp/barretenberg/cpp/dockerfiles/Dockerfile.circuits-x86_64-linux-clang-builder-runner#L7
|
This is now done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have accidentally needed this, but really I rather do this than roll back recent concept changes to barretenberg. As clang16 continues to improve C++20 spec compliance, and we now need it, we should document this.
The text was updated successfully, but these errors were encountered: