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

chore: employ just to run commonly used long cmds[skip ci] #2511

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

SteveLauC
Copy link
Member

@SteveLauC SteveLauC commented Sep 23, 2024

What does this PR do

Closes #2271

I found myself repeatedly opening that issue to copy the command to build the doc:

RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --all-features --no-deps --open

Let's wrap these commonly-used commands in a justfile.

This PR adds that doc command, now, to build the doc, one can simply run:

$ just doc

It passes the arguments to the underlying cargo doc (*args=''), so wen can use just doc --open to open the doc.

Checklist:

  • I have read CONTRIBUTING.md
  • I have written necessary tests and rustdoc comments
  • A change log has been added if this PR modifies nix's API

@SteveLauC SteveLauC merged commit 9c0bdac into nix-rust:master Sep 23, 2024
2 checks passed
@SteveLauC SteveLauC deleted the chore/justfile branch September 23, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider using a command runner to wrap the commonly used commands
1 participant