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

Rework project structure #126

Open
wants to merge 26 commits into
base: staging
Choose a base branch
from

Conversation

arron-speake-bluefruit
Copy link
Contributor

@arron-speake-bluefruit arron-speake-bluefruit commented Sep 2, 2022

  • Convert project to a workspace.
  • Format code with rustfmt.
  • Audit dependencies.
  • Pin dependency versions, update where possible.
  • Front-end build tool.
  • Fix GitHub actions for new structure.
  • Add documentation for new structure.

@arron-speake-bluefruit arron-speake-bluefruit marked this pull request as ready for review September 5, 2022 10:57
@laurent-rabatel-bluefruit
Copy link
Contributor

Should '.cargo-ok' be part of this PR?

# Using x.py

The intended way to build loadstone is using the x.py script in the root of the project. For usage information do `./x.py help SUBCOMMAND`.

Copy link
Contributor

Choose a reason for hiding this comment

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

What's the reason for calling it x.py?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

its named after a similar tool in the rustc repo, short for execute. wasn't sure on a proper name so i just went with it

@@ -2,13 +2,14 @@ FROM rust:buster

Copy link
Contributor

Choose a reason for hiding this comment

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

is the docker container used? If so, has its version been updated?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the docker container gets used for github actions, dockerhub has been update with this new version

loadstone/.cargo/config Outdated Show resolved Hide resolved
@@ -7,7 +7,7 @@ use ufmt::{uwrite, uwriteln};
/// Top level error type for the bootloader. Unlike the specific
/// module errors, this error contains textual descriptions of the
/// problem as it is meant to be directly reported through USART.
#[derive(Debug, Copy, Clone, PartialEq, Format)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Format)]
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do you need Eq?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

its not strictly required, it just tells the compiler that the Error type has a proper equivalence relation instead of a partial equivalence relation.

the general advice is to derive it where possible, since it lets the compiler perform more aggressive optimizations

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.

2 participants