Skip to content

Commit e6a9424

Browse files
L-serieshanno-becker
authored andcommitted
contributing: change BUILDING.md references
BUILDING.md currently points the user towards CONTRIBUTING.md regarding information on how to install the nix shell. Change the references to point towards the correct document. Signed-off-by: Andreas Hatziiliou <andreas.hatziiliou@savoirfairelinux.com>
1 parent 7a8cd19 commit e6a9424

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

scripts/autogen

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ def finalize_format_batch(batch):
112112
if p.returncode != 0:
113113
print(p.stderr)
114114
print(
115-
f"Failed to auto-format autogenerated code (clang-format return code {p.returncode}). Are you running in a nix shell? See BUILDING.md."
115+
f"Failed to auto-format autogenerated code (clang-format return code {p.returncode}). Are you running in a nix shell? See CONTRIBUTING.md."
116116
)
117117
exit(1)
118118

@@ -307,7 +307,7 @@ def format_content(content):
307307
if p.returncode != 0:
308308
print(p.stderr)
309309
print(
310-
f"Failed to auto-format autogenerated code (clang-format return code {p.returncode}). Are you running in a nix shell? See BUILDING.md."
310+
f"Failed to auto-format autogenerated code (clang-format return code {p.returncode}). Are you running in a nix shell? See CONTRIBUTING.md."
311311
)
312312
exit(1)
313313
return p.stdout

scripts/format

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,29 @@ error()
3030

3131
info "Formatting nix files"
3232
if ! command -v nixpkgs-fmt 2>&1 >/dev/null; then
33-
error "nixpkgs-fmt not found. Are you running in a nix shell? See BUILDING.md."
33+
error "nixpkgs-fmt not found. Are you running in a nix shell? See CONTRIBUTING.md."
3434
exit 1
3535
fi
3636

3737
nixpkgs-fmt "$ROOT"
3838

3939
info "Formatting shell scripts"
4040
if ! command -v shfmt 2>&1 >/dev/null; then
41-
error "shfmt not found. Are you running in a nix shell? See BUILDING.md."
41+
error "shfmt not found. Are you running in a nix shell? See CONTRIBUTING.md."
4242
exit 1
4343
fi
4444
shfmt -s -w -l -i 2 -ci -fn $(shfmt -f $(git grep -l '' :/))
4545

4646
info "Formatting python scripts"
4747
if ! command -v black 2>&1 >/dev/null; then
48-
error "black not found. Are you running in a nix shell? See BUILDING.md."
48+
error "black not found. Are you running in a nix shell? See CONTRIBUTING.md."
4949
exit 1
5050
fi
5151
black --include "(scripts/tests|scripts/simpasm|scripts/cfify|scripts/autogen|scripts/check-namespace|\.py$)" "$ROOT"
5252

5353
info "Formatting c files"
5454
if ! command -v clang-format 2>&1 >/dev/null; then
55-
error "clang-format not found. Are you running in a nix shell? See BUILDING.md."
55+
error "clang-format not found. Are you running in a nix shell? See CONTRIBUTING.md."
5656
exit 1
5757
fi
5858

0 commit comments

Comments
 (0)