From 26c5970f27b6ed5b687c46a89aaa5b1a7e5feb54 Mon Sep 17 00:00:00 2001
From: Simon Branford <4967+branfosj@users.noreply.github.com>
Date: Thu, 16 Jan 2025 11:06:59 +0000
Subject: [PATCH] document generate crates list

---
 docs/writing-easyconfig-files.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/writing-easyconfig-files.md b/docs/writing-easyconfig-files.md
index 5a66de634..74f7f8873 100644
--- a/docs/writing-easyconfig-files.md
+++ b/docs/writing-easyconfig-files.md
@@ -672,6 +672,19 @@ Here, the template strings `%(name)s` and `%(version)s` will be
 substituted from the `exts_list` entry elements ("pyCAP" and "0.1",
 respectively), not from the easyconfig values.
 
+### Generate a crates list {: #generate_crates_list }
+
+To generate a crates list for a package:
+
+1. Download and unpack the source code for the package you wish to build
+1. Change into the directory containing the top level `Cargo.toml.
+1. Run `python -m easybuild.easyblocks.generic.cargo .`
+
+If there is not already a lockfile then you may need to do the following to generate it:
+
+1. Load a recent Rust module
+1. cargo generate-lockfile
+
 ### Configure/build/install command options {: #configure_build_install_command_options }
 
 - **configopts**: options for configure command