Skip to content

Commit

Permalink
chore: Explain more make targets (#27)
Browse files Browse the repository at this point in the history
The new "docstrings" don't add much information, but they make it
easier comparing the `Makefile` in this project to that in
acap-rs-app-template because the diff is smaller and they only differ
where there is a good reason for doing so.

Also add and remove some newlines; double newlines only precede
sections to make them easier to spot.
  • Loading branch information
apljungquist authored Jun 19, 2024
1 parent c468ce9 commit 9390236
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ DOCKER_RUN = docker run \
--user $(shell id -u):$(shell id -g) \
axisecp/acap-native-sdk:1.12-$(ARCH)-ubuntu22.04


## Verbs
## =====

Expand All @@ -51,8 +52,6 @@ build: target/aarch64/$(PACKAGE)/_envoy target/armv7hf/$(PACKAGE)/_envoy
mkdir -p target/acap
cp $(patsubst %/_envoy,%/*.eap,$^) target/acap



## Install <PACKAGE> on <DEVICE_IP> using password <PASS> and assuming architecture <ARCH>
install:
@ $(DOCKER_RUN) sh -c ". /opt/axis/acapsdk/environment-setup-* && eap-install.sh $(DEVICE_IP) $(PASS) install" \
Expand Down Expand Up @@ -125,7 +124,7 @@ check_docs:
--workspace
.PHONY: check_docs

## _
## Check that the code is formatted correctly
check_format:
cargo fmt --check
.PHONY: check_format
Expand All @@ -136,8 +135,7 @@ check_generated_files: $(patsubst %/,%/src/bindings.rs,$(wildcard crates/*-sys/)
git --no-pager diff --exit-code HEAD -- $^
.PHONY: check_generated_files


## _
## Check that the code is free of lints
check_lint:
RUSTFLAGS="-Dwarnings" cargo clippy \
--all-targets \
Expand Down Expand Up @@ -165,12 +163,12 @@ check_tests:
## Fixes
## -----

## _
## Attempt to fix formatting automatically
fix_format:
cargo fmt
.PHONY: fix_format

## _
## Attempt to fix lints automatically
fix_lint:
cargo clippy --fix
.PHONY: fix_lint
Expand Down

0 comments on commit 9390236

Please sign in to comment.