`nix store ping` still shows in the manual

fricklerhandwerk commented 10 months ago

Problem

https://github.com/NixOS/nix/pull/9150 added an alias from nix store info to nix store ping as a short-cut, and now both commands show in the manual, with identical documentation.

Proposal

One of:

Override the documentation on nix store ping to say that it's a deprecated alias
Make nix store ping invisible in the manual

Checklist

[x] checked latest Nix manual (source)
[x] checked open documentation issues and pull requests for possible duplicates

Priorities

Add :+1: to issues you find important.

vicky1999 commented 10 months ago

@fricklerhandwerk can I work on this issue?

fricklerhandwerk commented 10 months ago

@vicky1999 sure, thanks a lot for your help! 🙂

vicky1999 commented 10 months ago

@fricklerhandwerk @Ericson2314 The name and synopsis of the documentation is generated from generate-manpage.nix file. Need some inputs on what to do for this.

simeoncarstens commented 6 months ago

nix store info does not seem to exist:

$ nix --version
nix (Nix) 2.18.1

$ nix store info
error: 'info' is not a recognised command
Try 'nix --help' for more information.

nix store ping does, though.

GreatTeacherOni commented 4 months ago

I ran into the same issue as @simeoncarstens, so I investigated a bit.

nix store info and nix nar pack are available starting from nix version 2.19.0 and higher. (Check commits of #9150)

When managing NixOS via "channels": This locks the version of nix to the channel. (See https://nix.dev/manual/nix/2.22/installation/upgrading) E.g. nixpkgs-unstable uses/is locked to nix version 2.18.2 atm.

When managing NixOS via "flakes": Adjust the flake (check https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/package-management/nix/default.nix which sets stable to 2_18 (reverted from 2_22)) but you can use latest (nixVersions.unstable has been removed)

One suggestion: The documentation for the experimental nix commands e.g. nix store info on https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-store-info should also show to which versions they apply, since it doesn't show in the URL. Similar to https://nix.dev/reference/nix-manual shows the overview to the references and their respective URL's.

fricklerhandwerk commented 4 months ago

Ah great, you found another error I introduced with the redirects. Thanks! Fixed here: https://github.com/NixOS/nixos-homepage/pull/1456

NixOS / nix