Closed Bug 1391776 Opened 2 years ago Closed 2 years ago

Minor taskgraph docs fixes

Categories

(Firefox Build System :: Task Configuration, task)

task
Not set

Tracking

(Not tracked)

RESOLVED FIXED
mozilla57

People

(Reporter: dustin, Assigned: dustin)

Details

Attachments

(1 file)

`./mach taskgraph morphed` is not documented, among other issues..
There's a "Tests" subsection with only one item in the kinds docs.

The first document should be an overview, with the mach commands in a separate doc.

Remove task definition YAML and inheritance -- it's totally unused now.

Try should get its own page.

Caches doc has multiple top-level headings.
Comment on attachment 8900436 [details]
Bug 1391776: cleanup of taskgraph docs;

https://reviewboard.mozilla.org/r/171782/#review177056

Thanks, nice cleanup!

::: taskcluster/docs/mach.rst:27
(Diff revision 1)
> +Each of these commands taskes a ``--parameters`` option giving a file with
> +parameters to guide the graph generation.  The decision task helpfully produces
> +such a file on every run, and that is generally the easiest way to get a
> +parameter file.  The parameter keys and values are described in
> +:doc:`parameters`; using that information, you may modify an existing
> +``parameters.yml`` or create your own.  The ``--parameters`` option can also
> +take an argument of the form ``project=<project>`` which will fetch the
> +parameters from the latest push on that project; or ``task-id=<task-id>`` which
> +will fetch the parameters from the given decision task. It defaults to
> +``project=mozilla-central``.

This should mention that it now defaults to `--parameters=project=mozilla-central` and is no longer necessary to download manually. Also, most of the examples in here (and how-tos.rst) can probably omit `-p/--parameters` for simplicity.

::: taskcluster/docs/mach.rst:27
(Diff revision 1)
> +   Get the optimized task graph
> +
> +``mach taskgraph morphed``
> +   Get the morhped task graph
> +
> +Each of these commands taskes a ``--parameters`` option giving a file with

nit: takes
Attachment #8900436 - Flags: review?(ahalberstadt) → review+
(In reply to Andrew Halberstadt [:ahal] from comment #5)
> > +will fetch the parameters from the given decision task. It defaults to
> > +``project=mozilla-central``.
> 
> This should mention that it now defaults to
> `--parameters=project=mozilla-central` and is no longer necessary to

..doesn't it? I'm confused..

> download manually. Also, most of the examples in here (and how-tos.rst) can
> probably omit `-p/--parameters` for simplicity.

that's fair..
(In reply to Dustin J. Mitchell [:dustin] from comment #6)
> (In reply to Andrew Halberstadt [:ahal] from comment #5)
> > > +will fetch the parameters from the given decision task. It defaults to
> > > +``project=mozilla-central``.
> > 
> > This should mention that it now defaults to
> > `--parameters=project=mozilla-central` and is no longer necessary to
> 
> ..doesn't it? I'm confused..

I just fail at reading comprehension.
https://hg.mozilla.org/mozilla-central/rev/080373b666c8
Status: NEW → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla57
Product: TaskCluster → Firefox Build System
You need to log in before you can comment on or make changes to this bug.