diff --git a/flake.nix b/flake.nix index e4a56cb1d..699f32713 100644 --- a/flake.nix +++ b/flake.nix @@ -1,7 +1,7 @@ # SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH # SPDX-License-Identifier: Apache-2.0 { - description = "a tool for connecting real-time power grid simulation equipment"; + description = "VILLASnode is a client/server application to connect simulation equipment and software."; inputs = { nixpkgs.url = "github:NixOS/nixpkgs/release-23.05"; @@ -57,19 +57,19 @@ separateDebugInfo = true; }; - # supported systems for native compilation + # Supported systems for native compilation supportedSystems = ["x86_64-linux" "aarch64-linux"]; - # supported systems to cross compile to + # Supported systems to cross compile to supportedCrossSystems = ["aarch64-multiplatform"]; - # generate attributes corresponding to all the supported systems + # Generate attributes corresponding to all the supported systems forSupportedSystems = lib.genAttrs supportedSystems; - # generate attributes corresponding to all supported combinations of system and crossSystem + # Generate attributes corresponding to all supported combinations of system and crossSystem forSupportedCrossSystems = f: forSupportedSystems (system: lib.genAttrs supportedCrossSystems (f system)); - # initialize nixpkgs for the specified `system` + # Initialize nixpkgs for the specified `system` pkgsFor = system: import nixpkgs { inherit system; @@ -134,19 +134,19 @@ }; }; in { - # standard flake attribute for normal packages (not cross-compiled) + # Standard flake attribute for normal packages (not cross-compiled) packages = forSupportedSystems ( system: packagesWith (pkgsFor system) ); - # non-standard attribute for cross-compilated packages + # Non-standard attribute for cross-compilated packages crossPackages = forSupportedCrossSystems ( system: crossSystem: packagesWith (crossPkgsFor system crossSystem) ); - # standard flake attribute allowing you to add the villas packages to your nixpkgs + # Standard flake attribute allowing you to add the villas packages to your nixpkgs overlays = { default = final: prev: packagesWith final; debug = final: prev: { @@ -159,7 +159,7 @@ }; }; - # standard flake attribute for defining developer environments + # Standard flake attribute for defining developer environments devShells = forSupportedSystems ( system: let pkgs = devPkgsFor system; @@ -194,7 +194,7 @@ } ); - # standard flake attribute to add additional checks to `nix flake check` + # Standard flake attribute to add additional checks to `nix flake check` checks = forSupportedSystems ( system: let pkgs = pkgsFor system; @@ -206,7 +206,7 @@ } ); - # standard flake attribute specifying the formatter invoked on `nix fmt` + # Standard flake attribute specifying the formatter invoked on `nix fmt` formatter = forSupportedSystems (system: (pkgsFor system).alejandra); }; } diff --git a/packaging/nix/libdatachannel.nix b/packaging/nix/libdatachannel.nix index 436916808..63a028320 100644 --- a/packaging/nix/libdatachannel.nix +++ b/packaging/nix/libdatachannel.nix @@ -18,9 +18,9 @@ stdenv.mkDerivation { nativeBuildInputs = [cmake pkg-config]; buildInputs = [libnice libpcap openssl]; cmakeFlags = [ - "-DUSE_NICE=ON" # use libnice for better protocol support - "-DNO_WEBSOCKET=ON" # villas uses libwebsockets instead - "-DNO_MEDIA=ON" # villas does not use media transport features + "-DUSE_NICE=ON" # Use libnice for better protocol support + "-DNO_WEBSOCKET=ON" # VILLASnode uses libwebsockets instead + "-DNO_MEDIA=ON" # VILLASnode does not use media transport features ]; meta = with lib; { description = "C/C++ WebRTC network library featuring Data Channels, Media Transport, and WebSockets"; diff --git a/packaging/nix/villas.nix b/packaging/nix/villas.nix index fb88cdecb..6f50dde17 100644 --- a/packaging/nix/villas.nix +++ b/packaging/nix/villas.nix @@ -1,7 +1,7 @@ # SPDX-FileCopyrightText: 2023 OPAL-RT Germany GmbH # SPDX-License-Identifier: Apache-2.0 { - # general configuration + # General configuration src, version, withGpl ? true, @@ -35,7 +35,7 @@ withNodeUldaq ? withAllNodes, withNodeWebrtc ? withAllNodes, withNodeZeromq ? withAllNodes, - # minimal dependencies + # Minimal dependencies cmake, common, coreutils, @@ -46,7 +46,7 @@ makeWrapper, pkg-config, stdenv, - # optional dependencies + # Optional dependencies comedilib, curl, czmq,