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

manual: remove suggestion of rust-project.json example #17144

Merged
merged 1 commit into from Apr 29, 2024

Conversation

cbiffle
Copy link
Contributor

@cbiffle cbiffle commented Apr 26, 2024

The manual has been linking to the repo

https://github.com/rust-analyzer/rust-project.json-example/tree/master

This repo does not contain a rust-project.json, does not appear to have ever contained a rust-project.json, and my bug report about this has gone untouched: rust-analyzer/rust-project.json-example#4

Since I can't figure out an example, this commit removes the link pending better documentation.

The manual has been linking to the repo

https://github.com/rust-analyzer/rust-project.json-example/tree/master

This repo does not contain a rust-project.json, does not appear to have _ever_ contained a rust-project.json, and my bug report about this has gone untouched: rust-analyzer/rust-project.json-example#4

Since I can't figure out an example, this commit removes the link pending better documentation.
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 26, 2024
@lnicola
Copy link
Member

lnicola commented Apr 26, 2024

image

That repo has an example of the third option, just like it was pointed out in rust-analyzer/rust-project.json-example#4 (comment).

@cbiffle
Copy link
Contributor Author

cbiffle commented Apr 26, 2024

That seems like an example of how to write a vscode configuration file. Is this section intended to be vscode-specific? Perhaps it would be worth telling readers to look in the .vscode directory (which I skipped, not being a vscode user, looking for a rust-project.json file that doesn't exist)?

@lnicola
Copy link
Member

lnicola commented Apr 26, 2024

Specify "rust-analyzer.linkedProjects": [ { "roots": […​], "crates": […​] }] inline.

It's literally that. It's not Code-specific, every LSP client will support changing the server settings. But the syntax depends on the client, unfortunately.

@Veykril
Copy link
Member

Veykril commented Apr 26, 2024

I wonder if we can make a simple CLI thing for r-a that turns a cargo project into a rust-project.json file. That feels like a nice way to help people figure out the format 🤔 Also let's archive that repo, it showing it in the vscode settings isn't really helpful imo.

@Veykril
Copy link
Member

Veykril commented Apr 26, 2024

Also there is https://json.schemastore.org/rust-project.json which might help (I dont remember if we have docs for rust-project.json)

@lnicola
Copy link
Member

lnicola commented Apr 26, 2024

We have https://rust-analyzer.github.io/manual.html#non-cargo-based-projects, which may or may not be up-to-date.

@Veykril
Copy link
Member

Veykril commented Apr 29, 2024

I'll merge this, I am not too fond of that example, especially because that third option isn't meant to be written manually anyways.
@bors r+

@bors
Copy link
Collaborator

bors commented Apr 29, 2024

📌 Commit 898d466 has been approved by Veykril

It is now in the queue for this repository.

@bors
Copy link
Collaborator

bors commented Apr 29, 2024

⌛ Testing commit 898d466 with merge 1e61ed7...

@bors
Copy link
Collaborator

bors commented Apr 29, 2024

☀️ Test successful - checks-actions
Approved by: Veykril
Pushing 1e61ed7 to master...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants