Skip to content

add documentation of tarball-ttl to nix-channel#13305

Merged
edolstra merged 3 commits intoNixOS:masterfrom
donottellmetonottellyou:donottellmetonottellyou/document-nix-channel-tarball-ttl
Jun 2, 2025
Merged

add documentation of tarball-ttl to nix-channel#13305
edolstra merged 3 commits intoNixOS:masterfrom
donottellmetonottellyou:donottellmetonottellyou/document-nix-channel-tarball-ttl

Conversation

@donottellmetonottellyou
Copy link
Contributor

Motivation

nix-channel is affected by the tarball-ttl setting, meaning that channels will only be updated if their tarballs are not in the cache. This patch simply adds documentation to the nix-channel command to point out this fact.

Context

https://discourse.nixos.org/t/nix-channel-forcing-an-update/64940?u=donttellmetonottellu


Add 👍 to pull requests you find important.

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

@donottellmetonottellyou
Copy link
Contributor Author

@fricklerhandwerk

How do you build the documentation locally? Or do you have to build the entire nix project?

@donottellmetonottellyou donottellmetonottellyou marked this pull request as ready for review May 31, 2025 22:11
@donottellmetonottellyou donottellmetonottellyou force-pushed the donottellmetonottellyou/document-nix-channel-tarball-ttl branch from cf33c9f to 6badd21 Compare May 31, 2025 23:05
@donottellmetonottellyou
Copy link
Contributor Author

donottellmetonottellyou commented May 31, 2025

I figured it out: nix build .#nix-manual

I found and fixed a typo (forgot to append .md)

Current addition is the Note:

image

@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/nix-channel-forcing-an-update/64940/13

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check if the link in the suggestion works. Thanks for finding the usability issue and helping to resolve it!

Approved morally, waiting for the fixups.

donottellmetonottellyou and others added 2 commits June 1, 2025 15:55
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
@donottellmetonottellyou
Copy link
Contributor Author

With new changes:

--update documentation

@fricklerhandwerk I checked that the link works, it does.

@edolstra edolstra enabled auto-merge June 2, 2025 12:05
@edolstra edolstra merged commit 97462bd into NixOS:master Jun 2, 2025
12 checks passed
@roberth roberth added backports created Does not require attention and can be filtered away backport 2.28-maintenance Automatically creates a PR against the branch backport 2.29-maintenance Automatically creates a PR against the branch labels Jul 30, 2025
mergify bot added a commit that referenced this pull request Jul 31, 2025
…3305

add documentation of tarball-ttl to nix-channel (backport #13305)
mergify bot added a commit that referenced this pull request Jul 31, 2025
…3305

add documentation of tarball-ttl to nix-channel (backport #13305)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.28-maintenance Automatically creates a PR against the branch backport 2.29-maintenance Automatically creates a PR against the branch backports created Does not require attention and can be filtered away documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants