From c4ba17b1ec7f01fa78dfb66afc1fc502ea90e1dd Mon Sep 17 00:00:00 2001 From: Wilfred Hughes Date: Tue, 8 Apr 2025 08:40:31 -0700 Subject: [PATCH] Clarify --graph-limit See discussion in #814 --- src/options.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/options.rs b/src/options.rs index 2f524f4e6..c41e1aec5 100644 --- a/src/options.rs +++ b/src/options.rs @@ -289,7 +289,9 @@ When multiple overrides are specified, the first matching override wins.")) .arg( Arg::new("graph-limit").long("graph-limit") .value_name("LIMIT") - .help("Use a text diff if the structural graph exceed this number of nodes in memory.") + .help("Use a text diff if the internal graph exceeds this number of vertices. This limit controls the worst case runtime and memory usage for difftastic. + +Higher values will allow difftastic to perform a structural diff in more cases. Higher values will also increase the time before difftastic gives up on structural diffing, and increase peak memory usage.") .default_value(format!("{}", DEFAULT_GRAPH_LIMIT)) .action(ArgAction::Set) .env("DFT_GRAPH_LIMIT")