Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit 995d890

Browse files
Add some header-goodies for et. (#51434)
I.e. a "open issues" and "file an issue" link. --------- Co-authored-by: Loïc Sharma <[email protected]>
1 parent ea3e6c0 commit 995d890

File tree

1 file changed

+44
-38
lines changed

1 file changed

+44
-38
lines changed

tools/engine_tool/README.md

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# The Engine Tool
22

3+
[![Open `e: engine-tool` issues](https://img.shields.io/github/issues/flutter/flutter/e%3A%20engine-tool)](https://github.com/flutter/flutter/issues?q=is%3Aopen+is%3Aissue+label%3A%22e%3A+engine-tool%22)
4+
35
This is a command line Dart program that automates workflows in the
46
`flutter/engine` repository.
57

6-
### Prerequisites
8+
> [!NOTE]
9+
> This tool is under development and is not yet ready for general use. Consider
10+
> filing a [feature request](https://github.com/flutter/flutter/issues/new?labels=e:engine-tool,team-engine).
11+
12+
## Prerequisites
713

814
The tool requires an initial `gclient sync -D` as described in the [repo setup
915
steps](https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment#getting-the-source)
@@ -13,56 +19,56 @@ before it will work.
1319

1420
The tool has the following commands.
1521

16-
* `help` - Prints helpful information about commands and usage.
17-
* `build` - Builds the Flutter engine.
18-
* `fetch` - Downloads Flutter engine dependencies.
19-
* `format` - Formats files in the engine tree using various off-the-shelf
20-
formatters.
21-
* `run` - Runs a flutter application with a local build of the engine.
22-
* `query builds` - Lists the CI builds described under `ci/builders` that the
23-
host platform is capable of executing.
22+
- `help` - Prints helpful information about commands and usage.
23+
- `build` - Builds the Flutter engine.
24+
- `fetch` - Downloads Flutter engine dependencies.
25+
- `format` - Formats files in the engine tree using various off-the-shelf
26+
formatters.
27+
- `run` - Runs a flutter application with a local build of the engine.
28+
- `query builds` - Lists the CI builds described under `ci/builders` that the
29+
host platform is capable of executing.
2430

2531
### Missing features
2632

2733
There are currently many missing features. Some overall goals are listed in the
2834
GitHub issue [here](https://github.com/flutter/flutter/issues/132807). Some
2935
desirable new features would do the following:
3036

31-
* Add a `doctor` command.
32-
* Update the engine checkout so that engine developers no longer have to remember
33-
to run `gclient sync -D`.
34-
* Build and test the engine using CI configurations locally, with the
35-
possibility to override or add new build options and targets.
36-
* Build engines using options coming only from the command line.
37-
* List tests and run them locally, automatically building their dependencies
38-
first. Automatically start emulators or simulators if they're needed to run a
39-
test.
40-
* Spawn individual builders remotely using `led` from `depot_tools`.
41-
* Encapsulate all code formatters, checkers, linters, etc. for all languages.
42-
* Find a compatible version of the flutter/flutter repo, check it out, and spawn
43-
tests from that repo with a locally built engine to run on an emulator,
44-
simulator or device.
45-
* Use a real logging package for prettier terminal output.
46-
* Wire the tool up to a package providing autocomplete like
47-
[cli_completion](https://pub.dev/packages/cli_completion.).
37+
- Add a `doctor` command.
38+
- Update the engine checkout so that engine developers no longer have to remember
39+
to run `gclient sync -D`.
40+
- Build and test the engine using CI configurations locally, with the
41+
possibility to override or add new build options and targets.
42+
- Build engines using options coming only from the command line.
43+
- List tests and run them locally, automatically building their dependencies
44+
first. Automatically start emulators or simulators if they're needed to run a
45+
test.
46+
- Spawn individual builders remotely using `led` from `depot_tools`.
47+
- Encapsulate all code formatters, checkers, linters, etc. for all languages.
48+
- Find a compatible version of the flutter/flutter repo, check it out, and spawn
49+
tests from that repo with a locally built engine to run on an emulator,
50+
simulator or device.
51+
- Use a real logging package for prettier terminal output.
52+
- Wire the tool up to a package providing autocomplete like
53+
[cli_completion](https://pub.dev/packages/cli_completion.).
4854

4955
The way the current tooling in the engine repo works may need to be rewritten,
5056
especially tests spawned by `run_tests.py`, in order to provide this interface.
5157

5258
## Contributing
5359

54-
* Follow the [Flutter style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo)
55-
for Dart code that are relevant outside of the framework repo. It contains
56-
conventions that go beyond code formatting, which
57-
we'll follow even if using `dart format` in the future.
58-
* Do not call directly into `dart:io` except from `main.dart`. Instead access
59-
the system only through the `Enviroment` object.
60-
* All commands must have unit tests. If some functionality needs a fake
61-
implementation, then write a fake implementation.
62-
* When adding or changing functionality, update this README.md file.
63-
* *Begin with the end in mind* - Start working from what the interface provided
64-
by this tool *should* be, then modify underlying scripts and tools to provide
65-
APIs to support that.
60+
- Follow the [Flutter style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo)
61+
for Dart code that are relevant outside of the framework repo. It contains
62+
conventions that go beyond code formatting, which
63+
we'll follow even if using `dart format` in the future.
64+
- Do not call directly into `dart:io` except from `main.dart`. Instead access
65+
the system only through the `Enviroment` object.
66+
- All commands must have unit tests. If some functionality needs a fake
67+
implementation, then write a fake implementation.
68+
- When adding or changing functionality, update this README.md file.
69+
- _Begin with the end in mind_ - Start working from what the interface provided
70+
by this tool _should_ be, then modify underlying scripts and tools to provide
71+
APIs to support that.
6672

6773
Run tests using `//flutter/testing/run_tests.py`:
6874

0 commit comments

Comments
 (0)