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.

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

cargo-config: rename to config.toml #259

Merged

Conversation

stefano-garzarella
Copy link
Member

@stefano-garzarella stefano-garzarella commented Sep 13, 2024

Summary of the PR

cargo recently complains about our cargo configuration file name:

$ cargo build
warning: `vhost/.cargo/config` is deprecated in favor of
`config.toml`
note: if you need to support cargo 1.38 or earlier, you can
symlink `config` to `config.toml`

As suggested, let's update the file name.

Requirements

Before submitting your PR, please make sure you addressed the following
requirements:

  • All commits in this PR have Signed-Off-By trailers (with
    git commit -s), and the commit message has max 60 characters for the
    summary and max 75 characters for each description line.
  • All added/changed functionality has a corresponding unit/integration
    test.
  • All added/changed public-facing functionality has entries in the "Upcoming
    Release" section of CHANGELOG.md (if no such section exists, please create one).
  • Any newly added unsafe code is properly documented.

@stefano-garzarella
Copy link
Member Author

Gentle ping :-) it's an easy one

@roypat
Copy link
Contributor

roypat commented Oct 2, 2024

I don't think the symlink is needed :D

$ cargo +1.38.0 build 
error: failed to parse manifest at `/home/ANT.AMAZON.COM/roypat/Development/rust-vmm/vhost/vhost/Cargo.toml`

Caused by:
  failed to parse the `edition` key

Caused by:
  supported edition values are `2015` or `2018`, but `2021` is unknown

@stefano-garzarella
Copy link
Member Author

I don't think the symlink is needed :D

Good point :-D

I'll remove the symlink!

$ cargo +1.38.0 build 
error: failed to parse manifest at `/home/ANT.AMAZON.COM/roypat/Development/rust-vmm/vhost/vhost/Cargo.toml`

Caused by:
  failed to parse the `edition` key

Caused by:
  supported edition values are `2015` or `2018`, but `2021` is unknown

@stefano-garzarella
Copy link
Member Author

v2:

Copy link
Contributor

@roypat roypat left a comment

Choose a reason for hiding this comment

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

nit: commit title still says "and add a symlink" (approving because you can update commit messages without dismissing approvals on github :)

cargo recently complains about our cargo configuration file name:

    $ cargo build
    warning: `vhost/.cargo/config` is deprecated in favor of
    `config.toml`
    note: if you need to support cargo 1.38 or earlier, you can
    symlink `config` to `config.toml`

As suggested, let's update the file name. We don't create the symlink
since 2021 edition is not supported by 1.38 toolchain:

    $ cargo +1.38.0 build
    error: failed to parse manifest at `vhost/Cargo.toml`

    Caused by:
      failed to parse the `edition` key

    Caused by:
      supported edition values are `2015` or `2018`, but `2021` is unknown

Signed-off-by: Stefano Garzarella <[email protected]>
@stefano-garzarella stefano-garzarella changed the title cargo-config: rename to config.toml and add a symlink cargo-config: rename to config.toml Oct 2, 2024
@stefano-garzarella
Copy link
Member Author

nit: commit title still says "and add a symlink" (approving because you can update commit messages without dismissing approvals on github :)

uff, it's monday, no wait it's not ;-P

fixed, thanks! :-)

@stefano-garzarella stefano-garzarella merged commit 51f8aa0 into rust-vmm:main Oct 2, 2024
29 checks passed
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.

3 participants