Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: cgo secp256k1 ldflags #18357

Merged
merged 4 commits into from
Nov 3, 2023
Merged

docs: cgo secp256k1 ldflags #18357

merged 4 commits into from
Nov 3, 2023

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Nov 3, 2023 •
edited by coderabbitai bot
Loading

Description

Closes:
#18232

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Documentation
    • Added instructions for avoiding symbol duplication when using go-ethereum and Cosmos's cgo secp256k1 together, with specific ldflags for Gcc and Clang compilers.

@JulianToledano JulianToledano requested a review from a team as a code owner November 3, 2023 14:37
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2023 •
edited
Loading

Walkthrough

The recent changes introduce instructions to avoid symbol duplication when using go-ethereum and Cosmos's cgo secp256k1 together. The diff provides two sets of ldflags for different compilers (Gcc and Clang) to allow multiple definitions of symbols. No code logic or functionality has been altered.

Changes

File Summary
crypto/keys/secp256k1/internal/secp256k1/README.md Introduced instructions for avoiding duplicated symbols when using go-ethereum and Cosmos's cgo secp256k1 together. Provided ldflags for Gcc and Clang compilers.

🐇🍂

In the season of fall, when leaves are a sight,
CodeRabbit hops in the soft moonlight.
With a twinkle in the eye and a skip in the stride,
Celebrating the changes, far and wide.

In the world of code, where symbols collide,
A solution is found, with compilers as guide.
No more duplication, no more hide,
In unity, go-ethereum and Cosmos reside.

So here's to the changes, small and big,
To the developers, dancing a coding jig.
In the world of tech, where we all abide,
CodeRabbit salutes you, with pride. 🥕🌕

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.json

@github-prbot github-prbot requested review from a team, alexanderbez and testinginprod and removed request for a team November 3, 2023 14:37
coderabbitai[bot]
coderabbitai bot reviewed Nov 3, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 10ae60e and dd11805.
Files selected for processing (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md

coderabbitai[bot]
coderabbitai bot reviewed Nov 3, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dd11805 and 432eff3.
Files selected for processing (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md

@JulianToledano JulianToledano linked an issue Nov 3, 2023 that may be closed by this pull request
[Bug]: use of cgo secp256k1 conflicts with geth imports #18232
Closed
1 task
coderabbitai[bot]
coderabbitai bot reviewed Nov 3, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 432eff3 and dd13e16.
Files selected for processing (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • crypto/keys/secp256k1/internal/secp256k1/README.md

@tac0turtle tac0turtle enabled auto-merge November 3, 2023 16:31
@tac0turtle tac0turtle added this pull request to the merge queue Nov 3, 2023
Merged via the queue into main with commit 9c2f464 Nov 3, 2023
47 of 51 checks passed
@tac0turtle tac0turtle deleted the julian/cgo-secp256k1-documentation branch November 3, 2023 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tac0turtle tac0turtle tac0turtle approved these changes

@alexanderbez alexanderbez Awaiting requested review from alexanderbez

@testinginprod testinginprod Awaiting requested review from testinginprod

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: use of cgo secp256k1 conflicts with geth imports
2 participants
@JulianToledano @tac0turtle