Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using flakes is not obvious, and no documentation has been written #2825

Closed
grahamc opened this issue May 10, 2019 · 4 comments
Closed

Using flakes is not obvious, and no documentation has been written #2825

grahamc opened this issue May 10, 2019 · 4 comments

Comments

@grahamc
Copy link
Member

grahamc commented May 10, 2019

Figuring out how to use flakes has been a challenge, mostly reading commits and commit messages. I checked the docs looking for guidance, and didn't find any. I think a good way to go from here would be to write docs as changes happen, but we can talk more Monday.

For the eager readers:

nix build

seems to build (about half the time, anyway #84)

@CSVdB CSVdB self-assigned this May 13, 2019
@CSVdB
Copy link
Contributor

CSVdB commented May 13, 2019

Thanks for the feedback!

Things I would like to write documentation about:

  • What does a flake.nix look like?
  • What is a flakeref?
  • Explain new features of flakes:
    • Building is pure by default
    • Make a list of flakes-related commands and explain what they do (or what changed)
  • Rewrite the original gist document
    Is there something else you would like to see explained? If so, let me know, or we can have a call about it!

@edolstra
Copy link
Member

Also, existing parts of the manual will need to be rewritten from the legacy interface/mechanisms (nix-channel, nix-env, nix-build, nix-shell) to flakes. In particular, the "Quick start" chapter and Part III on "Package Management".

@grahamc grahamc transferred this issue from another repository May 16, 2019
@grahamc grahamc added the flakes label May 16, 2019
@grahamc grahamc added this to the flakes-v2 milestone May 16, 2019
@CSVdB CSVdB removed their assignment Aug 9, 2019
@stale
Copy link

stale bot commented Feb 18, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the stale label Feb 18, 2021
@edolstra
Copy link
Member

Closing, nix flake --help shows info on flakes now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants