Skip to content

Document requirement to use same compiler for cargo-pgx and Toolkit#536

Merged
bors[bot] merged 1 commit intomainfrom
sv/document-compiler-parity
Sep 15, 2022
Merged

Document requirement to use same compiler for cargo-pgx and Toolkit#536
bors[bot] merged 1 commit intomainfrom
sv/document-compiler-parity

Conversation

@syvb
Copy link
Copy Markdown
Contributor

@syvb syvb commented Sep 15, 2022

The same compiler must be used to compile cargo-pgx and Toolkit, or bad things (undefined behaviour) might happen. See pgcentralfoundation/pgrx#687 for why this is the case.

This PR updates the installation documentation in the README to indicate this. I split the command in two since you only need to reinstall cargo-pgx, there's no need to re-run cargo pgx init.

@rtwalker
Copy link
Copy Markdown
Contributor

I split the command in two since you only need to reinstall cargo-pgx, there's no need to re-run cargo pgx init.

Considering this, do you want to make them two separate code blocks with the blurb about rust and cargo-pgx in between? Could also add something explaining that "there's no need to re-run cargo pgx init" after the second block for good measure

@syvb syvb force-pushed the sv/document-compiler-parity branch from 2d2bc7f to eee070c Compare September 15, 2022 20:07
@syvb syvb requested a review from rtwalker September 15, 2022 20:07
Copy link
Copy Markdown
Contributor

@rtwalker rtwalker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@syvb
Copy link
Copy Markdown
Contributor Author

syvb commented Sep 15, 2022

bors r+

@bors
Copy link
Copy Markdown
Contributor

bors Bot commented Sep 15, 2022

@bors bors Bot merged commit 2a4610c into main Sep 15, 2022
@bors bors Bot deleted the sv/document-compiler-parity branch September 15, 2022 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants