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

nheko: 0.6.3 -> 0.6.4, mtxclient: 0.2.0 -> 0.2.1 #63515

Merged
merged 1 commit into from Jun 19, 2019

Conversation

doronbehar
Copy link
Contributor

Motivation for this change

Update package nheko

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip" (Non depend on it)
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Other information

  • Updated the URL of mtxclient to use the Nheko-Reborn GitHub namspace.
  • Made both nheko and mtxclient aware of nlohmann_json with -Dnlohmann_json_DIR in cmakeFlags.

Use new URL of mtxclient. Make them both aware of nlohmann_json
dependency using `-Dnlohmann_json_DIR` in `cmakeFlags`.
Copy link
Contributor

@matthiasbeyer matthiasbeyer left a comment

Choose a reason for hiding this comment

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

Besides the one thing, this seems fine to me (not test-build this though).

}:

# These hashes and revisions are based on those from here:
# https://github.com/Nheko-Reborn/nheko/blob/v0.6.4/deps/CMakeLists.txt#L52
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems to be not relevant anymore, is it?

Copy link
Contributor

Choose a reason for hiding this comment

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

So it seems that the comment is there to tell the next person looking at the package that the hashes in rev are imported from that CMakeLists file...

I'd rather put this note in the commit message, which is (IMO, tbh) the first place to look at when curious about such a thing... not in the file itself at some other place...

Maybe someone else has a different opinion though...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Although I'm a beginner Nix user, I did understand what these lines meant - I figured these are dependencies pulled manually by the Nix build system. Therefor, I figured that I may need to update these as well according to the new version's requirement. My first attempt was to search in nheko's source tree for any mention of what specific version does it pull. At first I thought these will be git submodules versions but then I've reached that CMakeLists.txt file and found these revisions' hashes.

My opinion is that when someone will want to update Nheko to 7.0.0, hopefully he will see this comment which importantly has a v0.6.4 URL, and will check if the revisions have had an update in 7.0.0.

Additionally, not every contributor's git blame skills are good enough that he will easily find the original commit message (not mine) that added these dependencies which have hopefully (I haven't checked that myself) mentioned where did the revisions came from.

@doronbehar
Copy link
Contributor Author

doronbehar commented Jun 19, 2019 via email

@Ekleog
Copy link
Member

Ekleog commented Jun 19, 2019

Looks great, thanks! I agree with you that more comments are most often better, and the less people have to search for information the better.

Here I'd maybe have a doubt about this 0.6.4 in the URL, fearing it might get out-of-sync from the code below, but it's no big deal and there's no real better way of handling it I think, so… Thank you! :)

@Ekleog Ekleog merged commit 0b383bd into NixOS:master Jun 19, 2019
@doronbehar doronbehar deleted the nheko-update branch March 2, 2023 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants