Skip to content

Comments

Restore manual pages#9976

Merged
edolstra merged 1 commit intoNixOS:masterfrom
alois31:restore-manual-pages
Feb 12, 2024
Merged

Restore manual pages#9976
edolstra merged 1 commit intoNixOS:masterfrom
alois31:restore-manual-pages

Conversation

@alois31
Copy link
Contributor

@alois31 alois31 commented Feb 9, 2024

Commit d536c57 inadvertedly broke build and installation of all non-autogenerated manual pages (in particular, all the ones documenting the stable CLI), by moving the definition of the man-pages variable in doc/manual/local.mk after its usage in mk/lib.mk. Move including the former earlier so that the correct order is restored.

Motivation

Documentation is important. There should not be regressions.

Context

Regression caused by #5145.

Priorities and Process

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

Commit d536c57 inadvertedly broke build and
installation of all non-autogenerated manual pages (in particular, all the ones
documenting the stable CLI), by moving the definition of the man-pages variable
in doc/manual/local.mk after its usage in mk/lib.mk. Move including the former
earlier so that the correct order is restored.
@alois31 alois31 requested a review from edolstra as a code owner February 9, 2024 18:09
@Ericson2314
Copy link
Member

Thank you!

@alois31
Copy link
Contributor Author

alois31 commented Feb 9, 2024

I'm not sure the backports to 2.18 and 2.19 are needed, as it seems the regression was not backported either.

@edolstra edolstra merged commit d3c1997 into NixOS:master Feb 12, 2024
@github-actions
Copy link

Backport failed for 2.18-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.18-maintenance
git worktree add -d .worktree/backport-9976-to-2.18-maintenance origin/2.18-maintenance
cd .worktree/backport-9976-to-2.18-maintenance
git switch --create backport-9976-to-2.18-maintenance
git cherry-pick -x 8f3253c6f4041f500631e1dac5ba75f335e9c70a

@github-actions
Copy link

Backport failed for 2.19-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.19-maintenance
git worktree add -d .worktree/backport-9976-to-2.19-maintenance origin/2.19-maintenance
cd .worktree/backport-9976-to-2.19-maintenance
git switch --create backport-9976-to-2.19-maintenance
git cherry-pick -x 8f3253c6f4041f500631e1dac5ba75f335e9c70a

@github-actions
Copy link

Successfully created backport PR for 2.20-maintenance:

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/missing-manpage-for-nix-env-and-others/42850/2

tebowy pushed a commit to tebowy/nix that referenced this pull request Jul 11, 2024
Docs build: depend on locally built nix executable and not installed one

(cherry picked from commit ca72e3e)

===

includes changes from (because not doing so removes manpages):

Merge pull request NixOS#9976 from alois31/restore-manual-pages

Restore manual pages

(cherry picked from commit d3c1997)

Change-Id: I685ff16163ac552a1754570c03c992c63a461d50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants