2019-11-14 16:43:07 -05:00
|
|
|
## TAMER Makefile
|
|
|
|
|
#
|
2023-01-17 23:09:25 -05:00
|
|
|
# Copyright (C) 2014-2023 Ryan Specialty, LLC.
|
2020-03-06 11:05:18 -05:00
|
|
|
#
|
|
|
|
|
# This file is part of TAME.
|
2019-11-14 16:43:07 -05:00
|
|
|
#
|
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
|
# it under the terms of the GNU General Public License as published by
|
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
# (at your option) any later version.
|
|
|
|
|
#
|
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
# GNU General Public License for more details.
|
|
|
|
|
#
|
|
|
|
|
# You should have received a copy of the GNU General Public License
|
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
##
|
|
|
|
|
|
2021-10-01 09:38:31 -04:00
|
|
|
# `Makefile.am` is processed by Automake into `Makefile.in`, which is then
|
|
|
|
|
# processed by Autoconf into the final `Makefile`.
|
|
|
|
|
#
|
|
|
|
|
# The `@`-delimited variables are defined dynamically in `configure.ac`,
|
|
|
|
|
# which is processed by Autoconf into `configure`; they are populated based
|
|
|
|
|
# on the environment in which the `configure` script is invoked.
|
|
|
|
|
|
2023-03-10 14:11:55 -05:00
|
|
|
SHELL = /bin/bash -o pipefail
|
2019-11-14 16:43:07 -05:00
|
|
|
.DELETE_ON_ERROR:
|
|
|
|
|
|
2023-03-10 14:11:55 -05:00
|
|
|
.PHONY: all fix fmt check-fmt bench bench-build FORCE
|
2019-11-14 16:43:07 -05:00
|
|
|
|
2019-11-27 09:17:27 -05:00
|
|
|
CARGO_BUILD_FLAGS=@CARGO_BUILD_FLAGS@
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS=@RUSTFLAGS@
|
2019-11-27 09:17:27 -05:00
|
|
|
|
2023-03-10 14:11:55 -05:00
|
|
|
ontviz_svg := target/doc/tamer/asg/ontviz.svg
|
|
|
|
|
|
2021-07-23 22:23:10 -04:00
|
|
|
.DEFAULT: bin
|
|
|
|
|
|
2021-10-08 09:27:56 -04:00
|
|
|
all: bin doc bench-build
|
2021-07-23 22:23:10 -04:00
|
|
|
|
|
|
|
|
.PHONY: bin
|
|
|
|
|
bin:
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ build $(CARGO_BUILD_FLAGS) @FEATURES@
|
2019-11-14 16:43:07 -05:00
|
|
|
|
2019-11-18 13:24:22 -05:00
|
|
|
doc: html
|
2023-03-10 14:11:55 -05:00
|
|
|
html-am: rustdoc $(ontviz_svg)
|
|
|
|
|
|
|
|
|
|
.PHONY: rustdoc
|
|
|
|
|
rustdoc:
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ test --doc @FEATURES@
|
|
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ @CARGO_DOC_FLAGS@ doc --document-private-items @FEATURES@
|
2019-11-18 13:24:22 -05:00
|
|
|
|
2023-03-10 14:11:55 -05:00
|
|
|
$(ontviz_svg): FORCE
|
2023-03-10 15:10:13 -05:00
|
|
|
build-aux/asg-ontviz | $(DOT) -Tsvg > $@
|
2023-03-10 14:11:55 -05:00
|
|
|
|
2019-11-14 16:43:07 -05:00
|
|
|
# note that 'cargo check' is something else; see 'cargo --help'
|
|
|
|
|
test: check
|
2023-03-10 14:11:55 -05:00
|
|
|
check-am: check-lint check-fmt check-cargo check-docgen check-system
|
2023-02-22 22:44:46 -05:00
|
|
|
|
|
|
|
|
.PHONY: check-cargo
|
|
|
|
|
check-cargo:
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ test --quiet @FEATURES@
|
2019-11-14 16:43:07 -05:00
|
|
|
|
2023-03-10 14:11:55 -05:00
|
|
|
.PHONY: check-docgen
|
|
|
|
|
check-docgen:
|
2023-03-10 15:10:13 -05:00
|
|
|
build-aux/asg-ontviz >/dev/null
|
2023-03-10 14:11:55 -05:00
|
|
|
|
2023-02-22 22:44:46 -05:00
|
|
|
.PHONY: check-system
|
|
|
|
|
check-system: bin
|
|
|
|
|
tests/run-tests
|
|
|
|
|
|
|
|
|
|
.PHONY: check-lint
|
tamer: Integrate clippy
This invokes clippy as part of `make check` now, which I had previously
avoided doing (I'll elaborate on that below).
This commit represents the changes needed to resolve all the warnings
presented by clippy. Many changes have been made where I find the lints to
be useful and agreeable, but there are a number of lints, rationalized in
`src/lib.rs`, where I found the lints to be disagreeable. I have provided
rationale, primarily for those wondering why I desire to deviate from the
default lints, though it does feel backward to rationalize why certain lints
ought to be applied (the reverse should be true).
With that said, this did catch some legitimage issues, and it was also
helpful in getting some older code up-to-date with new language additions
that perhaps I used in new code but hadn't gone back and updated old code
for. My goal was to get clippy working without errors so that, in the
future, when others get into TAMER and are still getting used to Rust,
clippy is able to help guide them in the right direction.
One of the reasons I went without clippy for so long (though I admittedly
forgot I wasn't using it for a period of time) was because there were a
number of suggestions that I found disagreeable, and I didn't take the time
to go through them and determine what I wanted to follow. Furthermore, it
was hard to make that judgment when I was new to the language and lacked
the necessary experience to do so.
One thing I would like to comment further on is the use of `format!` with
`expect`, which is also what the diagnostic system convenience methods
do (which clippy does not cover). Because of all the work I've done trying
to understand Rust and looking at disassemblies and seeing what it
optimizes, I falsely assumed that Rust would convert such things into
conditionals in my otherwise-pure code...but apparently that's not the case,
when `format!` is involved.
I noticed that, after making the suggested fix with `get_ident`, Rust
proceeded to then inline it into each call site and then apply further
optimizations. It was also previously invoking the thread lock (for the
interner) unconditionally and invoking the `Display` implementation. That
is not at all what I intended for, despite knowing the eager semantics of
function calls in Rust.
Anyway, possibly more to come on that, I'm just tired of typing and need to
move on. I'll be returning to investigate further diagnostic messages soon.
2023-01-12 10:46:48 -05:00
|
|
|
check-lint:
|
2023-03-17 10:05:43 -04:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ clippy @FEATURES@
|
tamer: Integrate clippy
This invokes clippy as part of `make check` now, which I had previously
avoided doing (I'll elaborate on that below).
This commit represents the changes needed to resolve all the warnings
presented by clippy. Many changes have been made where I find the lints to
be useful and agreeable, but there are a number of lints, rationalized in
`src/lib.rs`, where I found the lints to be disagreeable. I have provided
rationale, primarily for those wondering why I desire to deviate from the
default lints, though it does feel backward to rationalize why certain lints
ought to be applied (the reverse should be true).
With that said, this did catch some legitimage issues, and it was also
helpful in getting some older code up-to-date with new language additions
that perhaps I used in new code but hadn't gone back and updated old code
for. My goal was to get clippy working without errors so that, in the
future, when others get into TAMER and are still getting used to Rust,
clippy is able to help guide them in the right direction.
One of the reasons I went without clippy for so long (though I admittedly
forgot I wasn't using it for a period of time) was because there were a
number of suggestions that I found disagreeable, and I didn't take the time
to go through them and determine what I wanted to follow. Furthermore, it
was hard to make that judgment when I was new to the language and lacked
the necessary experience to do so.
One thing I would like to comment further on is the use of `format!` with
`expect`, which is also what the diagnostic system convenience methods
do (which clippy does not cover). Because of all the work I've done trying
to understand Rust and looking at disassemblies and seeing what it
optimizes, I falsely assumed that Rust would convert such things into
conditionals in my otherwise-pure code...but apparently that's not the case,
when `format!` is involved.
I noticed that, after making the suggested fix with `get_ident`, Rust
proceeded to then inline it into each call site and then apply further
optimizations. It was also previously invoking the thread lock (for the
interner) unconditionally and invoking the `Display` implementation. That
is not at all what I intended for, despite knowing the eager semantics of
function calls in Rust.
Anyway, possibly more to come on that, I'm just tired of typing and need to
move on. I'll be returning to investigate further diagnostic messages soon.
2023-01-12 10:46:48 -05:00
|
|
|
|
2023-02-22 22:44:46 -05:00
|
|
|
.PHONY: check-fmt
|
2019-12-03 13:53:29 -05:00
|
|
|
check-fmt:
|
2021-12-02 11:34:56 -05:00
|
|
|
@CARGO@ +@RUST_TC@ @CARGO_FLAGS@ fmt -- --check
|
2019-12-03 13:53:29 -05:00
|
|
|
|
2019-12-04 09:57:08 -05:00
|
|
|
bench:
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ @CARGO_BENCH_PRE_FLAGS@ bench $(CARGO_BENCH_FLAGS) @FEATURES@
|
2019-12-04 09:57:08 -05:00
|
|
|
|
2021-10-08 09:27:56 -04:00
|
|
|
# Build but do not run benches (to ensures we didn't break them)
|
|
|
|
|
bench-build:
|
2022-12-15 12:12:25 -05:00
|
|
|
RUSTFLAGS="$(RUSTFLAGS)" @CARGO@ +@RUST_TC@ @CARGO_FLAGS@ @CARGO_BENCH_PRE_FLAGS@ build --benches @FEATURES@
|
2021-10-08 09:27:56 -04:00
|
|
|
|
2019-12-03 13:53:29 -05:00
|
|
|
fix: fmt
|
|
|
|
|
fmt:
|
2021-12-02 11:34:56 -05:00
|
|
|
@CARGO@ +@RUST_TC@ @CARGO_FLAGS@ fmt
|
2019-12-10 15:03:06 -05:00
|
|
|
|
|
|
|
|
clean-am:
|
2021-12-02 11:34:56 -05:00
|
|
|
@CARGO@ +@RUST_TC@ @CARGO_FLAGS@ clean
|
|
|
|
|
|
|
|
|
|
.PHONY: fetch
|
|
|
|
|
fetch:
|
|
|
|
|
@CARGO@ +@RUST_TC@ --locked fetch
|
|
|
|
|
|