talexander/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Releases Activity

nixos-render-docs: Improve redirects hint

Browse Source
This commit is contained in:
Robert Hensing 2025-08-06 15:00:42 +02:00
parent e179be6e15
commit 6d9be8e91b
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkgs/by-name/ni/nixos-render-docs/src/nixos_render_docs/redirects.py
View File

@ -59,6 +59,8 @@ This can happen when an identifier was added, renamed, or removed.
Added new content?
$ redirects add-content ❬identifier❭ ❬path❭
often:
$ redirects add-content ❬identifier❭ index.html
Moved existing content to a different output path?
$ redirects move-content ❬identifier❭ ❬path❭
@ -69,7 +71,11 @@ This can happen when an identifier was added, renamed, or removed.
Removed content? Redirect to alternatives or relevant release notes.
$ redirects remove-and-redirect ❬identifier❭ ❬target-identifier❭
NOTE: Run `nix-shell doc` or `nix-shell nixos/doc/manual` to make this command available.
NOTE: Run the right nix-shell to make this command available.
Nixpkgs:
$ nix-shell doc
NixOS:
$ nix-shell nixos/doc/manual
""")
error_messages.append("NOTE: If your build passes locally and you see this message in CI, you probably need a rebase.")
return "\n".join(error_messages)