Add section comments to generated nix to indicate which attributes ar…

…e "public".

CHANGELOG.md

@@ -1,4 +1,8 @@
-# 0.2.0
+# 0.2.0 - 0.2.1
+
+* Added comments to the generated nix build file to indicate which attributes are public and unlikely to change.
+
+# 0.1.0 - 0.2.0
 
 ## Bugfixes
 

Cargo.nix

@@ -1,5 +1,5 @@
 
-# Generated by crate2nix 0.2.0 with the command:
+# Generated by crate2nix 0.2.1 with the command:
 #   "generate" "-n" "<nixos-unstable>" "-o" "Cargo.nix"
 # See https://github.com/kolloch/crate2nix for more info.
 
@@ -11,10 +11,20 @@
   fetchurl? pkgs.fetchurl }:
 
 rec {
-    root_crate = crates."crate2nix 0.2.0 (path+file:///home/peter/gdrive/projects/crate2nix)";
+    #
+    # "public" attributes that we attempt to keep stable with new versions of crate2nix.
+    #
+    # Use this attribute to refer to the derivation building your root crate.
+    root_crate = crates."crate2nix 0.2.1 (path+file:///home/peter/gdrive/projects/crate2nix)";
+    # Refer your crate build derivation by name here.
     workspace_members = {
-        "crate2nix" = crates."crate2nix 0.2.0 (path+file:///home/peter/gdrive/projects/crate2nix)";
+        "crate2nix" = crates."crate2nix 0.2.1 (path+file:///home/peter/gdrive/projects/crate2nix)";
     };
+
+    #
+    # "private" attributes that may change in every new version of crate2nix.
+    #
+
     crates = {
         "aho-corasick 0.7.3 (registry+https://github.com/rust-lang/crates.io-index)"
             = buildRustCrate {
@@ -353,10 +363,10 @@ rec {
                     "structopt 0.2.15 (registry+https://github.com/rust-lang/crates.io-index)"
                 ];
             };
-        "crate2nix 0.2.0 (path+file:///home/peter/gdrive/projects/crate2nix)"
+        "crate2nix 0.2.1 (path+file:///home/peter/gdrive/projects/crate2nix)"
             = buildRustCrate {
                 crateName = "crate2nix";
-                version = "0.2.0";
+                version = "0.2.1";
                 edition = "2018";
                 src = (builtins.filterSource sourceFilter ./.);
                 libPath = "src/lib.rs";

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "crate2nix"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Peter Kolloch <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"

templates/build.nix.tera

@@ -13,16 +13,27 @@
   fetchurl? pkgs.fetchurl }:
 
 rec {
+    #
+    # "public" attributes that we attempt to keep stable with new versions of crate2nix.
+    #
+
     {%- if root_package_id %}
+    # Use this attribute to refer to the derivation building your root crate.
     root_crate = crates.{{root_package_id}};
     {%- endif -%}
     {%- if workspace_members %}
+    # Refer your crate build derivation by name here.
     workspace_members = {
     {%- for name, pkg_id in workspace_members %}
         {{name}} = crates.{{pkg_id}};
     {%- endfor %}
     };
     {%- endif %}
+
+    #
+    # "private" attributes that may change in every new version of crate2nix.
+    #
+
     crates = {
     {%- for crate in crates %}
         {{crate.package_id}}