crankstart icon indicating copy to clipboard operation
crankstart copied to clipboard

crankstart cannot be included in a workspace as a git submodule

Open sgeos opened this issue 2 years ago • 6 comments

crankstart is workspace with one member. It cannot, therefore, be included in another Rust workspace as a git submodule. The workaround is to install crankstart and the user workspace in the same directory.

ideal directory structure

game_project_workspace/
game_project_workspace/crankstart/
game_project_workspace/game_core_library/
game_project_workspace/game_pc/
game_project_workspace/game_playdate/

workaround directory structure

crankstart/
game_project_workspace/
game_project_workspace/game_core_library/
game_project_workspace/game_pc/
game_project_workspace/game_playdate/

EDIT: Another workaround is probably to include crankstart as a git submodule and exclude it from the user workspace.

sgeos avatar Dec 05 '22 16:12 sgeos

I'd imagined you'd use crankstart as a dependency from crates, so this would not be an issue.

What are you trying to do where you want to include crankstart in your workspace?

rtsuk avatar Dec 05 '22 17:12 rtsuk

I guess I wanted to put crankstart in the workspace because the instructions for using it include the following entries in Cargo.toml.

[dependencies]
crankstart = { path = "../crankstart" }
crankstart-sys = { path = "../crankstart/crankstart-sys" }

Dropping crankstart into the workspace would allow the above path to be used as is. At the time, crankstart and my project workspace were in completely different directories. Since I have a bunch of different things in my workspace, adding crankstart to the mix did not seem unreasonable. The directory structure is a lot like the one in my original post, only there are two libraries.

sgeos avatar Dec 06 '22 19:12 sgeos

Not unreasonable, but I favor leaving it as-it in expectation that it might eventually end up being published to crates.io.

rtsuk avatar Dec 06 '22 23:12 rtsuk

Are there plans to publish to crates.io?

sgeos avatar Dec 07 '22 01:12 sgeos

Nothing more solid than an expectation.

rtsuk avatar Dec 07 '22 16:12 rtsuk

Would you be open to help? I would love to assist.

apollocatlin avatar Dec 15 '22 05:12 apollocatlin