Nixpkgs-manual: Anchor Links Reference The Wrong File

by ADMIN 54 views

Introduction

The nixpkgs-manual is a crucial component of the Nix package manager, providing users with a comprehensive guide to using Nix. However, a recent issue has been reported where the anchor links in the manual reference the wrong file, causing them to malfunction. In this article, we will delve into the details of this issue, explore the steps to reproduce it, and discuss the expected behavior.

Nixpkgs Version

The issue was encountered using the unstable version of Nixpkgs, specifically version 25.05.

Describe the Bug

The anchor links in the nixpkgs-manual currently reference index.html instead of the correct file, manual.html. This is causing the links to malfunction and not direct users to the correct content.

Steps to Reproduce

To reproduce this issue, follow these steps:

  1. Build the nixpkgs-manual: Run the command nix build nixpkgs#nixpkgs-manual to build the manual.
  2. Open the manual: Use the command xdg-open result/share/doc/nixpkgs/manual.html to open the manual in your default web browser.
  3. Try clicking an anchor link: Click on any anchor link in the manual to see the issue in action.

Expected Behavior

The anchor links should correctly reference manual.html and direct users to the correct content within the manual.

Screenshots

Unfortunately, there are no screenshots provided to illustrate this issue.

Relevant Log Output

There is no relevant log output to provide, as the issue is primarily related to the anchor links in the manual.

Additional Context

There is no additional context provided to help understand the issue.

System Metadata

The following system metadata is provided:

  • System: x86_64-linux
  • Host OS: Linux 6.12.23, NixOS, 25.05 (Warbler)
  • Multi-user: yes
  • Sandbox: yes
  • Version: nix-env (Lix, like Nix) 2.91.1
  • System type: x86_64-linux
  • Additional system types: i686-linux, x86_64-v1-linux, x86_64-v2-linux, x86_64-v3-linux
  • Features: gc, signed-caches
  • System configuration file: /etc/nix/nix.conf
  • User configuration files: /home/nezia/.config/nix/nix.conf:/etc/xdg/nix/nix.conf:/home/nezia/.local/share/flatpak/exports/etc/xdg/nix/nix.conf:/var/lib/flatpak/exports/etc/xdg/nix/nix.conf:/home/nezia/.nix-profile/etc/xdg/nix/nix.conf:/nix/profile/etc/xdg/nix/nix.conf:/home/nezia/.local/state/nix/profile/etc/xdg/nix/nix.conf:/etc/profiles/per-user/nezia/etc/xdg/nix/nix.conf:/nix/var/nix/profiles/default/etc/xdg/nix/nix.conf:/run/current-system/sw/etc/g/nix/nix.conf
  • Store directory: /nix/store
  • State directory: /nix/var/nix
  • Data directory: /nix/store/jxs248g15qklggm9gfyddq822vkcrfg2-lix-2.91.1/share
  • Channels (root): "nixos"
  • Nixpkgs: /nix/store/isfbldda5j8j6x3nbv1zim0c0dpf90v8-source

Notify Maintainers

Please tag this issue in your pull request description (i.e., Resolves #ISSUE).

Is this issue important to you?

Add a :+1: reaction to issues you find important.

Q: What is the issue with the nixpkgs-manual anchor links?

A: The anchor links in the nixpkgs-manual currently reference index.html instead of the correct file, manual.html. This is causing the links to malfunction and not direct users to the correct content.

Q: What is the expected behavior of the anchor links?

A: The anchor links should correctly reference manual.html and direct users to the correct content within the manual.

Q: How can I reproduce the issue?

A: To reproduce this issue, follow these steps:

  1. Build the nixpkgs-manual: Run the command nix build nixpkgs#nixpkgs-manual to build the manual.
  2. Open the manual: Use the command xdg-open result/share/doc/nixpkgs/manual.html to open the manual in your default web browser.
  3. Try clicking an anchor link: Click on any anchor link in the manual to see the issue in action.

Q: What is the current Nixpkgs version that is affected by this issue?

A: The issue was encountered using the unstable version of Nixpkgs, specifically version 25.05.

Q: What are the system metadata that are relevant to this issue?

A: The following system metadata are relevant to this issue:

  • System: x86_64-linux
  • Host OS: Linux 6.12.23, NixOS, 25.05 (Warbler)
  • Multi-user: yes
  • Sandbox: yes
  • Version: nix-env (Lix, like Nix) 2.91.1
  • System type: x86_64-linux
  • Additional system types: i686-linux, x86_64-v1-linux, x86_64-v2-linux, x86_64-v3-linux
  • Features: gc, signed-caches
  • System configuration file: /etc/nix/nix.conf
  • User configuration files: /home/nezia/.config/nix/nix.conf:/etc/xdg/nix/nix.conf:/home/nezia/.local/share/flatpak/exports/etc/xdg/nix/nix.conf:/var/lib/flatpak/exports/etc/xdg/nix/nix.conf:/home/nezia/.nix-profile/etc/xdg/nix/nix.conf:/nix/profile/etc/xdg/nix/nix.conf:/home/nezia/.local/state/nix/profile/etc/xdg/nix/nix.conf:/etc/profiles/per-user/nezia/etc/xdg/nix/nix.conf:/nix/var/nix/profiles/default/etc/xdg/nix/nix.conf:/run/current-system/sw/etc/xdg/nix/nix.conf
  • Store directory: /nix/store
  • State directory: /nix/var/nix
  • Data directory: /nix/store/jxs248g15qklggm9gfyddq822vkcrfg2-lix-2.91.1/share
  • Channels (root): "nixos"
  • Nixpkgs: /nix/store/isfbldda5j8j6x3nbv1zim0c0dpf90v8-source

Q: How can I help resolve this issue?

A: You can help resolve this issue by:

  • Reporting the issue: If you encounter this issue, please report it to the Nixpkgs maintainers.
  • Providing additional information: If you have any additional information about the issue, please provide it to the maintainers.
  • Helping with the fix: If you are familiar with the Nixpkgs codebase, you can help with the fix by submitting a pull request.

Q: Is this issue important to you?

A: Yes, this issue is important to me. I want to ensure that the anchor links in the nixpkgs-manual work correctly and provide users with the correct content.

Q: How can I stay up-to-date with the latest developments on this issue?

A: You can stay up-to-date with the latest developments on this issue by:

  • Following the Nixpkgs repository: Follow the Nixpkgs repository on GitHub to stay informed about the latest developments.
  • Subscribing to the Nixpkgs mailing list: Subscribe to the Nixpkgs mailing list to receive updates about the issue.
  • Checking the Nixpkgs issue tracker: Check the Nixpkgs issue tracker to see the latest updates on the issue.