Skip to content

Pedantry #98

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Pedantry #98

wants to merge 4 commits into from

Conversation

HU90m
Copy link
Member

@HU90m HU90m commented Apr 1, 2025

Sits atop #97

@hcallahan-lowrisc
Copy link
Contributor

Looks like all the commits from this already went in with #97 ?
Also, pendantry -> pedantry (if only to join in the pedantry myself) :D

@hcallahan-lowrisc
Copy link
Contributor

Wait, the GitHub UI shows 5 commits in #97, and says merged, but lowRISC:main only has 1 new commit. I’m either very dumb or some weirdness is going on with the UI.

@nbdd0121
Copy link
Collaborator

nbdd0121 commented Apr 2, 2025

Hugo pushed to the PR after it's already in the merge queue (with only a single commit)

@HU90m HU90m changed the title Pendantry Pedantry Apr 3, 2025
HU90m added 4 commits April 3, 2025 11:15
This is more idomatic; variables should be cammel case.
The pname of this derivation is 'llvm-cheriot', suggesting this is a
distinct package from 'llvm'. Changed the identifier to match.

Note: Underscore is usually used to deliminate name from version.
This isn't the 'ot' version of python. Rather, it is a the python
environment for opentitan, so ot should be part of the package name.
This changes the name to reflect that.
This derivation isn't the 'ot' version of bazel. It's just bazelisk,
with the upstream's bazel shell autocompletions.
@HU90m
Copy link
Member Author

HU90m commented Apr 3, 2025

Hugo pushed to the PR after it's already in the merge queue (with only a single commit)

Yeah, sorry, probably need to be more careful with branch reuse now we have merge queues

@hcallahan-lowrisc
Copy link
Contributor

hcallahan-lowrisc commented Apr 3, 2025

I’m much more inclined to blame GitHub UI as it’s clearly their bug, only 1 commit was actually merged so the UI shouldn’t become incorrect if you mess with the branch afterwards :(

IMG_1966

@@ -56,7 +56,7 @@
})
Copy link
Contributor

Choose a reason for hiding this comment

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

Re. the naming for let bindings, is there a standard somewhere that camel case is preferred? Or maybe just that camel > kebab > snake? I see all kinds of stuff. Maybe we could setup a lint if there is a standard somewhere

Copy link
Collaborator

Choose a reason for hiding this comment

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

https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md says use camel case for (non-package-name) variable names.

@@ -81,7 +81,7 @@
cheriot = pkgs.mkShell {
Copy link
Contributor

Choose a reason for hiding this comment

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

Re. b7bb917, the commit message doesn't seem to match the changes? The change is just snake -> kebab

@@ -6,7 +6,7 @@
ncurses5-fhs,
Copy link
Contributor

@hcallahan-lowrisc hcallahan-lowrisc Apr 7, 2025

Choose a reason for hiding this comment

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

Re. ecea895, the commit message doesn't seem to match the changes again? This appears to just be a snake -> kebab change for the nix binding of opentitan's python environment.
I think the spirit of the message is correct though, we should probably give the naming another thought at some time. Ideally 'python' is distinct from a 'pythonEnv', but also should the pname contain the project that particular env is intended for? I'm undecided. I almost think that it would be better if we could namespace as e.g. packages.${system}.opentitan.pythonEnv, but flakes doesn't allow that output schema.

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