Skip to content

Commit

Permalink
Edit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
roberth committed Apr 21, 2024
1 parent a3ff75f commit 90ccd40
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 4 additions & 4 deletions doc/manual/src/contributing/hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ Configure your editor to use the `clangd` from the `.#native-clangStdenvPackages
> Some other editors (e.g. Emacs, Vim) need a plugin to support LSP servers in general (e.g. [lsp-mode](https://github.com/emacs-lsp/lsp-mode) for Emacs and [vim-lsp](https://github.com/prabirshrestha/vim-lsp) for vim).
> Editor-specific setup is typically opinionated, so we will not cover it here in more detail.
## Formatting and pre-commit
## Formatting and pre-commit hooks

You may run the formatters as a one-off using:

Expand All @@ -292,9 +292,9 @@ This installs [pre-commit](https://pre-commit.com) using [cachix/git-hooks.nix](
When making a commit, pay attention to the console output.
If it fails, run `git add --patch` to approve the suggestions _and commit again_.

To refresh the config, do the following:
- if you use `make format`: stop and start your `nix develop` shell.
- if you use the pre-commit hook: stop and start, and run `pre-commit-hooks-install` again.
To refresh pre-commit hook's config file, do the following:
1. Stop and start your `nix develop` shell.
2. If you also use the pre-commit hook, also run `pre-commit-hooks-install` again.

## Add a release note

Expand Down
3 changes: 2 additions & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@
inherit fileset stdenv;
};

# https://github.com/NixOS/nixpkgs/pull/214409
# See https://github.com/NixOS/nixpkgs/pull/214409
# Remove when fixed in this flake's nixpkgs
pre-commit =
if prev.stdenv.hostPlatform.system == "i686-linux"
then (prev.pre-commit.override (o: { dotnet-sdk = ""; })).overridePythonAttrs (o: { doCheck = false; })
Expand Down

0 comments on commit 90ccd40

Please sign in to comment.