employer
/
tame
1
0
Fork 0
Code Packages Releases Activity
tame/tamer/Makefile.am

68 lines
1.9 KiB
Makefile
Raw Normal View History

TAMER: Initial commit
2019-11-14 16:43:07 -05:00
## TAMER Makefile
#
Copyright year update 2021
2021-07-22 15:00:15 -04:00
# Copyright (C) 2014-2021 Ryan Specialty Group, LLC.
Copyright year 2020 update
2020-03-06 11:05:18 -05:00
#
# This file is part of TAME.
TAMER: Initial commit
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/>.
##
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
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.
TAMER: Initial commit
2019-11-14 16:43:07 -05:00
.DELETE_ON_ERROR:
tamer: Makefile.am (bench-build): New target, default for all Build the benchmarks by default to catch breakages without having to incur the cost of actually running them.
2021-10-08 09:27:56 -04:00
.PHONY: all fix fmt check-fmt bench bench-build
TAMER: Initial commit
2019-11-14 16:43:07 -05:00
Introduce CARGO_BUILD_FLAGS This is intended to permit passing `--release`, since dev builds are terribly slow (e.g. 6s -> 0.2s). See README.md for more information.
2019-11-27 09:17:27 -05:00
CARGO_BUILD_FLAGS=@CARGO_BUILD_FLAGS@
tamer: Makefile.am (all): Binaries and doc `all` was previously the target for binaries only.
2021-07-23 22:23:10 -04:00
.DEFAULT: bin
tamer: Makefile.am (bench-build): New target, default for all Build the benchmarks by default to catch breakages without having to incur the cost of actually running them.
2021-10-08 09:27:56 -04:00
all: bin doc bench-build
tamer: Makefile.am (all): Binaries and doc `all` was previously the target for binaries only.
2021-07-23 22:23:10 -04:00
.PHONY: bin
bin:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ build $(CARGO_BUILD_FLAGS) @FEATURES@
TAMER: Initial commit
2019-11-14 16:43:07 -05:00
Makefile.am (doc, html): New documentation target
2019-11-18 13:24:22 -05:00
doc: html
html-am:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ test --doc @FEATURES@
@CARGO@ +@RUST_TC@ @CARGO_DOC_FLAGS@ doc --document-private-items @FEATURES@
Makefile.am (doc, html): New documentation target
2019-11-18 13:24:22 -05:00
TAMER: Initial commit
2019-11-14 16:43:07 -05:00
# note that 'cargo check' is something else; see 'cargo --help'
test: check
Makefile.am (check): Check whether formatting is required Given that developers should be doing TDD and therefore running this target frequently, this has the effect of providing immediate feedback when formatting is needed and outputting a diff. Developers will then quickly understand what changes need to be made to avoid future issues (and can run `cargo fmt` to fix it), at which point they'll rarely ever encounter formatting errors. The original purpose was to ensure pipelines fail when the formatter has not been run.
2019-12-03 13:53:29 -05:00
check-am: check-fmt
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ test @FEATURES@
TAMER: Initial commit
2019-11-14 16:43:07 -05:00
Makefile.am (check): Check whether formatting is required Given that developers should be doing TDD and therefore running this target frequently, this has the effect of providing immediate feedback when formatting is needed and outputting a diff. Developers will then quickly understand what changes need to be made to avoid future issues (and can run `cargo fmt` to fix it), at which point they'll rarely ever encounter formatting errors. The original purpose was to ensure pipelines fail when the formatter has not been run.
2019-12-03 13:53:29 -05:00
check-fmt:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ fmt -- --check
Makefile.am (check): Check whether formatting is required Given that developers should be doing TDD and therefore running this target frequently, this has the effect of providing immediate feedback when formatting is needed and outputting a diff. Developers will then quickly understand what changes need to be made to avoid future issues (and can run `cargo fmt` to fix it), at which point they'll rarely ever encounter formatting errors. The original purpose was to ensure pipelines fail when the formatter has not been run.
2019-12-03 13:53:29 -05:00
Makefile.am (bench): New target The configure script will determine if nightly is required for running benchmarks, because `test` is currently an unstable feature.
2019-12-04 09:57:08 -05:00
bench:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ @CARGO_BENCH_PRE_FLAGS@ bench $(CARGO_BENCH_FLAGS) @FEATURES@
Makefile.am (bench): New target The configure script will determine if nightly is required for running benchmarks, because `test` is currently an unstable feature.
2019-12-04 09:57:08 -05:00
tamer: Makefile.am (bench-build): New target, default for all Build the benchmarks by default to catch breakages without having to incur the cost of actually running them.
2021-10-08 09:27:56 -04:00
# Build but do not run benches (to ensures we didn't break them)
bench-build:
@CARGO@ +@RUST_TC@ @CARGO_BENCH_PRE_FLAGS@ build --benches @FEATURES@
Makefile.am (check): Check whether formatting is required Given that developers should be doing TDD and therefore running this target frequently, this has the effect of providing immediate feedback when formatting is needed and outputting a diff. Developers will then quickly understand what changes need to be made to avoid future issues (and can run `cargo fmt` to fix it), at which point they'll rarely ever encounter formatting errors. The original purpose was to ensure pipelines fail when the formatter has not been run.
2019-12-03 13:53:29 -05:00
fix: fmt
fmt:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ fmt
Makefile.am (clean): New target Not sure how I missed this one.
2019-12-10 15:03:06 -05:00
clean-am:
tamer: Switch back to nightly toolchain This is to support two things: 1. Early switch to 2021 Edition, which is stable Oct 21; and 2. To make use of unstable const features. The rationale is that switching to nightly does not really have any significant downside for us, given that TAMER is used only by us and the only risk is that unstable features may change a bit, which can be mitigated with certain precautions. The rationale for each unstable feature will be documented as they are used, including documentation on what would be required to remove it and what functionality would be lost / need to change in doing so.
2021-10-01 09:38:31 -04:00
@CARGO@ +@RUST_TC@ clean