Skip to content

Commit 9b1b869

Browse files
authored
docs: improve the Reference -> Command Line section (#609)
1 parent a70a57c commit 9b1b869

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/taskgraph/main.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -228,30 +228,32 @@ def logfile(spec):
228228

229229
@command(
230230
"tasks",
231-
help="Show all tasks in the taskgraph.",
231+
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.",
232232
defaults={"graph_attr": "full_task_set"},
233233
)
234234
@command(
235-
"full", help="Show the full taskgraph.", defaults={"graph_attr": "full_task_graph"}
235+
"full",
236+
help="Show the full task graph. The full task graph consists of the full task set, with edges (dependencies) between tasks.",
237+
defaults={"graph_attr": "full_task_graph"},
236238
)
237239
@command(
238240
"target",
239-
help="Show the set of target tasks.",
241+
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.",
240242
defaults={"graph_attr": "target_task_set"},
241243
)
242244
@command(
243245
"target-graph",
244-
help="Show the target graph.",
246+
help="Show the target task graph. The target task graph consists of the target task set, with edges (dependencies) between tasks.",
245247
defaults={"graph_attr": "target_task_graph"},
246248
)
247249
@command(
248250
"optimized",
249-
help="Show the optimized graph.",
251+
help="Show the optimized task graph, which is the target task set with tasks optimized out (filtered, omitted, or replaced) and edges representing dependencies.",
250252
defaults={"graph_attr": "optimized_task_graph"},
251253
)
252254
@command(
253255
"morphed",
254-
help="Show the morphed graph.",
256+
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.",
255257
defaults={"graph_attr": "morphed_task_graph"},
256258
)
257259
@argument("--root", "-r", help="root of the taskgraph definition relative to topsrcdir")

0 commit comments

Comments
 (0)