aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFernando Apesteguía <fernape@FreeBSD.org>2023-03-17 11:49:38 +0000
committerFernando Apesteguía <fernape@FreeBSD.org>2023-03-17 16:19:41 +0000
commit6fca32fd5f3e253458303acd71c44ed6a6c9bd4d (patch)
tree801f2d1b44e1f878d971712c8fe34b60838f99d3
parent6d5e8da29b9fd742a022893590f185781a736900 (diff)
downloaddoc-6fca32fd5f.tar.gz
doc-6fca32fd5f.zip
[phb]: Document the use of Makefile.crates
Some people don't know about this. Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D39143
-rw-r--r--documentation/content/en/books/porters-handbook/special/_index.adoc3
1 files changed, 3 insertions, 0 deletions
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index 4ebeb7f84e..9221eef41d 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -505,6 +505,9 @@ For ports that use Cargo, define `USES=cargo`.
|`CARGO_CRATES`
|
|List of crates the port depends on. Each entry needs to have a format like `cratename-semver` for example, `libc-0.2.40`. Port maintainers can generate this list from [.filename]#Cargo.lock# using `make cargo-crates`. Manually bumping crate versions is possible but be mindful of transitive dependencies.
+If the list generated by `make cargo-crates` is big, it might be convenient to place it inside a `Makefile.crates` file in the top-level port directory.
+If present, the ports framework sources that file automatically.
+This helps keeping the main port Makefile withing a reasonable size.
|`CARGO_FEATURES`
|