Skip to content

Commit

Permalink
Update dependencies and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Sukant Hajra committed Aug 11, 2024
1 parent bbc8aad commit c145027
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion doc/internal/params.el
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
;; run-type must be "executable"
(run-target-short . "org2gfm")
;; run-target-long will always prefix "bin/"
(nix-latest . "2.23.3")
(nix-latest . "2.24.1")
(nix-stable . "2.18.5")
(nixos-latest . "24.05")
(platforms . "\n\
Expand Down
2 changes: 1 addition & 1 deletion doc/nix-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Hopefully, this alleviates any worry about installing a complex program on your

> **<span class="underline">NOTE:</span>** You don't need this step if you're running NixOS, which comes with Nix baked in.
Though the latest version of Nix is Nix 2.23.3, we'll be installing the version that the last release of NixOS (24.05) uses, specifically Nix 2.18.5. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.
Though the latest version of Nix is Nix 2.24.1, we'll be installing the version that the last release of NixOS (24.05) uses, specifically Nix 2.18.5. As discussed in the included [introduction to Nix](nix-introduction.md), this version is considered stable by the Nix community.

The following command calls the official installation script for the recommended version of Nix. Note, this script will require `sudo` access.

Expand Down
2 changes: 1 addition & 1 deletion doc/nix-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ However, if industrial users move to flakes to address these problems, we have t

### Nix quick releases compete with stability<a id="sec-4-2-3"></a>

The latest major version of the Nix package manager is currently Nix 2.23.3, but NixOS 24.05, the latest stable release of NixOS, uses Nix 2.18.5. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.18.5 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.
The latest major version of the Nix package manager is currently Nix 2.24.1, but NixOS 24.05, the latest stable release of NixOS, uses Nix 2.18.5. NixOS is the primary way the Nix package manager gets used in the field. Far fewer users install Nix as a package manager atop another operating system. From a community perspective it makes sense to consider Nix 2.18.5 the stable release of the package manager. This version gets the most scrutiny and critical bug fixes.

As mentioned above, there are strong reasons to use still-experimental features, particularly flakes. However, APIs and calculated hashes change too frequently in experimental features from version-to-version. By sticking with the version used in NixOS, we get less breaking changes. For example, the [flake.lock](../flake.lock) file included with this project has calculated hashes for dependencies. These hashes were computed with Nix 2.18.5, and could change with later versions.

Expand Down
8 changes: 4 additions & 4 deletions doc/nix-usage-flakes.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ After a successful call of `nix build`, you'll see one or more symlinks for each
readlink result*
```

/nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
/nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

Following these symlinks, we can see the files the project provides:

Expand All @@ -288,7 +288,7 @@ It's common to configure these “result” symlinks as ignored in source contro
nix path-info .#org2gfm
```

/nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
/nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

## Running commands in a shell<a id="sec-4-6"></a>

Expand Down Expand Up @@ -401,7 +401,7 @@ nix shell --ignore-environment \
--command which org2gfm
```

/nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm/bin/org2gfm
/nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm/bin/org2gfm

What we do with local flake references can work just as well with remote flake references.

Expand Down Expand Up @@ -429,7 +429,7 @@ nix profile list
Flake attribute: packages.x86_64-linux.org2gfm
Original flake URL: git+file:///home/shajra/src/nix-project
Locked flake URL: git+file:///home/shajra/src/nix-project
Store paths: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
Store paths: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

If we want to uninstall a program from our profile, we do so by the index from this list:

Expand Down
8 changes: 4 additions & 4 deletions doc/nix-usage-flakes.org
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

Following these symlinks, we can see the files the project provides:

Expand Down Expand Up @@ -467,7 +467,7 @@ nix path-info .#<<get("package-attr-short")>>
#+end_src

#+results: nix-build-path
: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

** Running commands in a shell

Expand Down Expand Up @@ -629,7 +629,7 @@ nix shell --ignore-environment \
#+end_src

#+RESULTS: nix-shell-remote
: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm/bin/org2gfm
: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm/bin/org2gfm

What we do with local flake references can work just as well with remote flake
references.
Expand Down Expand Up @@ -680,7 +680,7 @@ nix profile list --profile /tmp/nix-profile | ansifilter
: Flake attribute: packages.x86_64-linux.org2gfm
: Original flake URL: git+file:///home/shajra/src/nix-project
: Locked flake URL: git+file:///home/shajra/src/nix-project
: Store paths: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
: Store paths: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

If we want to uninstall a program from our profile, we do so by the index from
this list:
Expand Down
4 changes: 2 additions & 2 deletions doc/nix-usage-noflakes.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ We can build this package with `nix-build` from the project root:
nix-build --attr packages.x86_64-linux.org2gfm .
```

/nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
/nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

If we omit the path to a Nix file, `nix-build` will try to build `default.nix` in the current directory. If we omit the `--attr` switch and argument, `nix-build` will try to build packages it finds in the root of the attribute tree.

Expand All @@ -173,7 +173,7 @@ The output of `nix-build` shows us where in `/nix/store` our package has been bu
readlink result*
```

/nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
/nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

Following these symlinks, we can see the files the project provides:

Expand Down
4 changes: 2 additions & 2 deletions doc/nix-usage-noflakes.org
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ nix-build --attr <<get("package-attr-long")>> .
#+end_src

#+RESULTS: nix-build
: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

If we omit the path to a Nix file, =nix-build= will try to build =default.nix=
in the current directory. If we omit the =--attr= switch and argument,
Expand All @@ -328,7 +328,7 @@ readlink result*
#+end_src

#+RESULTS: nix-build-link
: /nix/store/vgsqy4nmsravl5dbi5vr4q88q8pq0xxz-org2gfm
: /nix/store/pf0g885myl26nmcln8ldhzv5c7nx78vf-org2gfm

Following these symlinks, we can see the files the project provides:

Expand Down
38 changes: 19 additions & 19 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c145027

Please sign in to comment.