From 6e36df59a0df485cf99d893bdba5b11b8fc8bf3a Mon Sep 17 00:00:00 2001 From: Gabriel Bustamante Date: Thu, 5 Dec 2024 11:24:33 -0600 Subject: [PATCH 1/2] docs: improve the Reference -> Command Line section --- src/taskgraph/main.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/taskgraph/main.py b/src/taskgraph/main.py index b2b7a593b..8ca9ae4f1 100644 --- a/src/taskgraph/main.py +++ b/src/taskgraph/main.py @@ -228,30 +228,30 @@ def logfile(spec): @command( "tasks", - help="Show all tasks in the taskgraph.", + help="Show the full task set in the task graph. The full task set includes all tasks defined by any kind, without edges (dependencies) between them.", defaults={"graph_attr": "full_task_set"}, ) @command( - "full", help="Show the full taskgraph.", defaults={"graph_attr": "full_task_graph"} + "full", help="Show the full task graph. The full task graph consists of the full task set, with edges (dependencies) between tasks.", defaults={"graph_attr": "full_task_graph"} ) @command( "target", - help="Show the set of target tasks.", + help="Show the target task set in the task graph. The target task set includes the tasks which have indicated they should be run, without edges (dependencies) between them.", defaults={"graph_attr": "target_task_set"}, ) @command( "target-graph", - help="Show the target graph.", + help="Show the target task graph. The target task graph consists of the target task set, with edges (dependencies) between tasks.", defaults={"graph_attr": "target_task_graph"}, ) @command( "optimized", - help="Show the optimized graph.", + help="Show the optimized task graph, which is the target task set with tasks optimized out (filtered, omitted, or replaced) and edges representing dependencies.", defaults={"graph_attr": "optimized_task_graph"}, ) @command( "morphed", - help="Show the morphed graph.", + help="Show the morphed graph, which is the optimized task graph with additional morphs applied. It retains the same meaning as the optimized task graph but in a form more palatable to TaskCluster.", defaults={"graph_attr": "morphed_task_graph"}, ) @argument("--root", "-r", help="root of the taskgraph definition relative to topsrcdir") From 0407dabfc4deacab39f6ddd819764c09e5233c4a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 2 Jan 2025 16:39:16 +0000 Subject: [PATCH 2/2] style: pre-commit.ci auto fixes [...] --- src/taskgraph/main.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/taskgraph/main.py b/src/taskgraph/main.py index 8ca9ae4f1..32335073b 100644 --- a/src/taskgraph/main.py +++ b/src/taskgraph/main.py @@ -232,7 +232,9 @@ def logfile(spec): defaults={"graph_attr": "full_task_set"}, ) @command( - "full", help="Show the full task graph. The full task graph consists of the full task set, with edges (dependencies) between tasks.", defaults={"graph_attr": "full_task_graph"} + "full", + help="Show the full task graph. The full task graph consists of the full task set, with edges (dependencies) between tasks.", + defaults={"graph_attr": "full_task_graph"}, ) @command( "target",