Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve the Reference -> Command Line section #609

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: improve the Reference -> Command Line section #609

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
963a9a3
docs: improve the Reference -> Command Line section
gabrielBusta Dec 5, 2024
deeb281
style: pre-commit.ci auto fixes [...]
pre-commit-ci[bot] Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/taskgraph/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,30 +228,32 @@ def logfile(spec):

@command(
"tasks",
help="Show all tasks in the taskgraph.",
help="Show the full task set in the taskgraph. 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 taskgraph. The full taskgraph consists of the full task set, with edges (dependencies) between tasks.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: s/taskgraph/task graph

While we're making things less confusing, let's make it clear that we're not talking about the package here. Note this comment applies to all the commands.

defaults={"graph_attr": "full_task_graph"},
)
@command(
"target",
help="Show the set of target tasks.",
help="Show the target task set in the taskgraph. 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 taskgraph. The target taskgraph 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 taskgraph, 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 taskgraph with additional morphs applied. It retains the same meaning as the optimized taskgraph 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")
Expand Down
Loading