Better organize Workspace (Directory Structure)

[phip1611]

I want to suggest the following directory structure.

.github
book
BUILDING.md
...
ws/ 
  Cargo.toml <-- workspace definitions
  uefi/
   Cargo.toml <-- dependencies of `uefi` crate
  uefi-services/
  xtask/
  ...

This will make the directory structure much cleaner and the main Cargo.toml file shorter (do not mix workspace definitions with regular crate attributes). I can work on it, if you give me the go for it. Thoughts?

[nicholasbishop]

I like the idea of moving the uefi package out of the root. The uefi package would then be more like all the other packages in the repo, and as you say it would cleanly separate out the [workspace] part of the root Cargo.toml from the uefi package part.

I think I would personally prefer not to move all the packages under a new directory though, all other things being equal I prefer less nesting, and our root isn't all that crowded. So I would propose essentially mkdir uefi && mv src uefi/src and update Cargo.toml accordingly.

Ignoring hidden files, our repo root would then look like this:

BUILDING.md
CHANGELOG.md
CONTRIBUTING.md
Cargo.toml
LICENSE
PUBLISHING.md
README.md
book
rust-toolchain.toml
template
uefi
uefi-macros
uefi-services
uefi-test-runner
xtask

[phip1611]

I think I would personally prefer not to move all the packages under a new directory though, all other things being equal I prefer less nesting, and our root isn't all that crowded.

yeah, that ws/ approach originates from my work project. But I'm fine with less nesting.

[GabrielMajeri]

I think we should first draw a conclusion on the discussion started in #560. If we end up deciding to break the uefi-services crate into logger, global-allocator etc. then we'll have a lot of many small crates in many directories, and having them in the same subdirectory (e.g. src or crates) will be more ergonomic than keeping them all in the root.

[phip1611]

I think these are two relatively independent steps, aren't they?

So, in a next step, we could move everything into a directory called /ws/ or whatever. Smaller commits, more PRs, better review-ability, aye? :)

[GabrielMajeri]

I think these are two relatively independent steps, aren't they?

So, in a next step, we could move everything into a directory called /ws/ or whatever. Smaller commits, more PRs, better review-ability, aye? :)

Yeah, sure, it's just more work to do the move in two steps, vs. moving everything to where it needs to be in a go :)

[phip1611]

Yeah, sure, it's just more work to do the move in two steps, vs. moving everything to where it needs to be in a go :)

I personally prefer variant A but I'm open for whatever the team consensus will be :)