[helpdoc] Update reference docs
diff --git a/tools/fx/build.md b/tools/fx/build.md
index 307f3fd..f036f5d 100644
--- a/tools/fx/build.md
+++ b/tools/fx/build.md
@@ -3,7 +3,6 @@
Command | Description
------- | -----------
[args](cmd/args.md) | manually edit args.gn for the current build directory
-[bazel](cmd/bazel.md) | Run experimental Bazel build for Fuchsia platform tree
[build](cmd/build.md) | Run Ninja to build Fuchsia
[clean](cmd/clean.md) | clean the current Fuchsia build artifacts
[clean-build](cmd/clean-build.md) | Clean the build directory and then perform a full build
@@ -26,7 +25,6 @@
[ninja](cmd/ninja.md) | directly run the build system. Don't use for regular workflows.
[ninjatrace2json](cmd/ninjatrace2json.md) | Collect Ninja trace information for analysis in chrome://tracing
[repro](cmd/repro.md) | Locally replicate the result of infra builds and tests
-[run-in-build-dir](cmd/run-in-build-dir.md) | Run the given command at the root of the current build directory
[self-build](cmd/self-build.md) | build the minimal host dependencies to run fx main workflows
[set](cmd/set.md) | set up a build directory
[set-build-dir](cmd/set-build-dir.md) | set the default build directory used by other fx commands
@@ -34,5 +32,4 @@
[check-deps](cmd/check-deps.md) | checks dependency graph in areas
[compdb](cmd/compdb.md) | DEPRECATED
[goma](cmd/goma.md) | manage Goma distributed compilation client
-[symbol-index](cmd/symbol-index.md) | (deprecated) manipulate the symbol-index file
-[validate-sdk](cmd/validate-sdk.md) | Attempt to build a few known SDK-based OOT repos based on a core SDK
+[symbol-index](cmd/symbol-index.md) | manipulate the symbol-index file
diff --git a/tools/fx/build_toc.yaml b/tools/fx/build_toc.yaml
index 94bd5b5..3163455 100644
--- a/tools/fx/build_toc.yaml
+++ b/tools/fx/build_toc.yaml
@@ -1,8 +1,6 @@
toc:
- title: "args"
path: /reference/tools/fx/cmd/args.md
-- title: "bazel"
- path: /reference/tools/fx/cmd/bazel.md
- title: "build"
path: /reference/tools/fx/cmd/build.md
- title: "clean"
@@ -47,8 +45,6 @@
path: /reference/tools/fx/cmd/ninjatrace2json.md
- title: "repro"
path: /reference/tools/fx/cmd/repro.md
-- title: "run-in-build-dir"
- path: /reference/tools/fx/cmd/run-in-build-dir.md
- title: "self-build"
path: /reference/tools/fx/cmd/self-build.md
- title: "set"
@@ -65,5 +61,3 @@
path: /reference/tools/fx/cmd/goma.md
- title: "symbol-index"
path: /reference/tools/fx/cmd/symbol-index.md
-- title: "validate-sdk"
- path: /reference/tools/fx/cmd/validate-sdk.md
diff --git a/tools/fx/cmd/bazel.md b/tools/fx/cmd/bazel.md
deleted file mode 100644
index c37f2e7..0000000
--- a/tools/fx/cmd/bazel.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# fx bazel
-
-Run experimental Bazel build for Fuchsia platform tree
-
-```none
-usage: fx bazel ...
-
-This is a highly experimental command to run Bazel build commands
-directly from the command-line. Only useful for debugging the platform
-build. Note that currently Bazel is automatically invoked by Ninja
-when `fx build` is invoked.
-
-This runs Bazel in a custom workspace under the Fuchsia build directory,
-use `fx bazel info workspace` to print its path.
-
-This command will fail if you have not run `fx gen` or `fx set` previously.
-
-All arguments are passed to the Bazel binary.
-```
-
-[bazel source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/bazel)
diff --git a/tools/fx/cmd/build-metrics.md b/tools/fx/cmd/build-metrics.md
deleted file mode 100644
index 72ca6d7..0000000
--- a/tools/fx/cmd/build-metrics.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# fx build-metrics
-
-manage build metrics configuration
-
-```none
-usage:
- fx build-metrics status
- Show if build metrics collection is enabled or disabled
-
- fx build-metrics enable
- Enable build metrics collection in fx build.
-
- fx build-metrics disable
- Disable build metrics collection in fx build.
-
- fx build-metrics login
- Authenticate to be able to write data to BQ.
-
- fx build-metrics upload
- Upload any logs/metrics that may have accumulated.
-
-If you opt-in to metrics collection, data will be collected and used by
-Google in accordance with the Google Privacy Policy
-(https://policies.google.com/privacy)
-and Employee Privacy Policy (go/epp).
-```
-
-[build-metrics source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/build-metrics)
diff --git a/tools/fx/cmd/check-goldens.md b/tools/fx/cmd/check-goldens.md
deleted file mode 100644
index 79ed2d5..0000000
--- a/tools/fx/cmd/check-goldens.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# fx check-goldens
-
-Checks all golden file comparisons in the GN build graph.
-
-```none
-usage: fx check-goldens [--list] [--regex] [SEARCH_TERM]
-
-Reruns golden file checks in the current build, relying on the
-"golden_files" build API module. That is, unless `--list` is passed, in
-which case this command only prints out the associated goldens.
-
-The goldens may be filtered by a substring of their source path (e.g., a
-full source-relative directory) or by a regular expression; if no search
-term is provided, all accessible golden files will be matched.
-
-TODO(crbug.com/gn/301): This command may deal in stale metadata. Until this
-bug is resolved, users must take care to make sure their build metadata is
-up to data (e.g., via `fx gen`) before invoking this command.
-
- --list just list the matched goldens; do not perform any checks.
- --regex if set, the search term will be matched as a regular expression.
-
-```
-
-[check-goldens source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/check-goldens)
diff --git a/tools/fx/cmd/component-graph.md b/tools/fx/cmd/component-graph.md
new file mode 100644
index 0000000..8e874d5
--- /dev/null
+++ b/tools/fx/cmd/component-graph.md
@@ -0,0 +1,9 @@
+# fx component-graph
+
+start component graph server to map component topology
+
+```none
+No help found. Try `fx component-graph -h`
+```
+
+[component-graph source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/component-graph)
diff --git a/tools/fx/cmd/component-surveyor.md b/tools/fx/cmd/component-surveyor.md
new file mode 100644
index 0000000..3d32fab
--- /dev/null
+++ b/tools/fx/cmd/component-surveyor.md
@@ -0,0 +1,14 @@
+# fx component-surveyor
+
+produce a dump of v1 components in CSV form.
+
+```none
+usage: fx component-surveyor [OUT_FILE]
+This dump includes the following information:
+- The names of all components known to the package server
+- Categorization of components by group
+- Service dependencies between components
+- cmx features used by components
+```
+
+[component-surveyor source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/component-surveyor)
diff --git a/tools/fx/cmd/coverage.md b/tools/fx/cmd/coverage.md
deleted file mode 100644
index e0613b0..0000000
--- a/tools/fx/cmd/coverage.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# fx coverage
-
-Runs test and exports coverage data.
-
-```none
-usage: fx coverage [--lcov-output-path <path>] [--html-output-dir <directory>] [-h|--help] [testName ...]
-
-Runs test and exports coverage data.
-
---html-output-dir: directory to output test coverage HTML to
---lcov-output-path: path to write output lcov to
--h|--help: prints help message
-```
-
-[coverage source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/coverage)
diff --git a/tools/fx/cmd/debug.md b/tools/fx/cmd/debug.md
new file mode 100644
index 0000000..db189e7
--- /dev/null
+++ b/tools/fx/cmd/debug.md
@@ -0,0 +1,9 @@
+# fx debug
+
+(deprecated) run the debug agent on target and connect to it with zxdb
+
+```none
+No help found. Try `fx debug -h`
+```
+
+[debug source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/debug)
diff --git a/tools/fx/cmd/emu.md b/tools/fx/cmd/emu.md
new file mode 100644
index 0000000..0c9bd2c
--- /dev/null
+++ b/tools/fx/cmd/emu.md
@@ -0,0 +1,40 @@
+# fx emu
+
+start fuchsia in an emulator
+
+```none
+usage: fx emu [-a <mode>] [-c <text>] [-N [-I <ifname>]] [-u <path>] [-v <build_variant>] [-g <port> [-r <fps>] [-t <cmd>]] [-x <port> [-X <directory>]] [-e <directory>] [-w <size>] [-s <cpus>] [-m <mb>] [-k <authorized_keys_file>] [-K <kernel_image>] [-z <zbi_image>] [-f <fvm_image>] [-p mouse|touch] [-H|--headless] [--audio] [--hidpi-scaling] [--software-gpu] [--debugger]
+ -a <mode> acceleration mode (auto, off, kvm, hvf, hax), default is auto
+ -c <text> append item to kernel command line
+ -ds <size> extends the fvm image size to <size> bytes. Default is twice the original size
+ -N run with emulated nic via tun/tap
+ -I <ifname> uses the tun/tap interface named ifname
+ -u <path> execute emu if-up script, default: linux: no script, macos: tap ifup script.
+ -v <build_variant> uses the build system variant to modify the total memory.
+ -e <directory> location of emulator, defaults to looking in prebuilt/third_party/android/aemu/release/PLATFORM
+ -g <port> enable gRPC service on port to control the emulator, default is 5556 when WebRTC service is enabled
+ -r <fps> webrtc frame rate when using gRPC service, default is 30
+ -t <cmd> execute the given command to obtain turn configuration
+ -x <port> enable WebRTC HTTP service on port
+ -X <directory> location of grpcwebproxy, defaults to looking in prebuilt/third_party/grpcwebproxy
+ -w <size> window size, default is 1280x800
+ -s <cpus> number of cpus, 1 for uniprocessor
+ -m <mb> total memory, in MB
+ -k <authorized_keys_file> SSH authorized keys file, otherwise defaults to ~/.ssh/fuchsia_authorized_keys
+ -K <kernel_image> path to image to use as kernel, defaults to kernel generated by the current build.
+ -z <zbi_image> path to image to use as ZBI, defaults to zircon-a generated by the current build.
+ -Z <zbi tool> path to a version of the `zbi` tool to use; defaults to the one in the current build directory.
+ -f <fvm_image> path to full FVM image, defaults to image generated by the current build.
+ -F <fvm tool> path to a version of the `fvm` tool to use; defaults to the one in the current build directory.
+ -A <arch> architecture of images (x64, arm64), default is the current build.
+ -p mouse|touch set pointing device used on emulator: mouse or multitouch screen; defaults to mouse.
+ -H|--headless run in headless mode
+ --audio run with audio hardware added to the virtual machine
+ --hidpi-scaling enable pixel scaling on HiDPI devices
+ --host-gpu run with host GPU acceleration
+ --software-gpu run without host GPU acceleration
+ --debugger pause on launch and wait for a debugger process to attach before resuming
+ --no-build do not attempt to build the fvm and zbi tools and the zbi image
+```
+
+[emu source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/emu)
diff --git a/tools/fx/cmd/fidlcat.md b/tools/fx/cmd/fidlcat.md
index 13527af..f4c83d9 100644
--- a/tools/fx/cmd/fidlcat.md
+++ b/tools/fx/cmd/fidlcat.md
@@ -1,6 +1,6 @@
# fx fidlcat
-Deprecated, please use "ffx debug fidl"
+(deprecated) run fidlcat on given target.
```none
No help found. Try `fx fidlcat -h`
diff --git a/tools/fx/cmd/regen-goldens.md b/tools/fx/cmd/regen-goldens.md
new file mode 100644
index 0000000..814cb45
--- /dev/null
+++ b/tools/fx/cmd/regen-goldens.md
@@ -0,0 +1,41 @@
+# fx regen-goldens
+
+regenerates golden files in the source tree
+
+```none
+Usage: fx regen-goldens PATTERN ... [--list] [--reset] [FX_TEST_FLAGS]
+
+Regenerates golden files for tools that match the given substring patterns.
+If no patterns are provided, regenerates for all tools.
+
+ --list List matching tools and their golden directories, and exit.
+ --reset Delete existing goldens first. (See "Troubleshooting" below.)
+
+ All other flags are forwarded to fx test. A useful one is -o/--output to
+ show test output, which prints the filenames being regenerated.
+
+Examples:
+
+ fx regen-goldens # regen all goldens
+ fx regen-goldens fidlgen_ # regen fidlgen_* goldens
+ fx regen-goldens fidlc -o # regen fidlc goldens, with verbose output
+
+Troubleshooting:
+
+ Try passing the --reset flag if you encounter one of these situations:
+
+ GN error, when goldens.txt is missing:
+ ERROR at //build/testing/golden_test.gni:86:28: Could not read file.
+ goldens_list = read_file("${invoker.goldens_dir}/goldens.txt", ...)
+
+ Ninja error, when goldens.txt contains nonexistent files:
+ ninja: error: '.../foo.golden', needed by 'host_x64/gen/.../foo.golden',
+ missing and no known rule to make it
+
+ Formatting error, when goldens have invalid syntax (e.g. from a merge conflict):
+ ACTION //..._reformat_goldens(//build/toolchain:host_x64)
+ /usr/bin/env /bin/sh -c \'.../rustfmt\'\ ...
+ error: expected identifier, found `<<`
+```
+
+[regen-goldens source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/regen-goldens)
diff --git a/tools/fx/cmd/run-in-build-dir.md b/tools/fx/cmd/run-in-build-dir.md
deleted file mode 100644
index 7652f02..0000000
--- a/tools/fx/cmd/run-in-build-dir.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# fx run-in-build-dir
-
-Run the given command at the root of the current build directory
-
-```none
-No help found. Try `fx run-in-build-dir -h`
-```
-
-[run-in-build-dir source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/run-in-build-dir)
diff --git a/tools/fx/cmd/run.md b/tools/fx/cmd/run.md
new file mode 100644
index 0000000..86dc419
--- /dev/null
+++ b/tools/fx/cmd/run.md
@@ -0,0 +1,27 @@
+# fx run
+
+build Fuchsia and push to device
+
+```none
+usage: fx run [--no-build|[NINJA OPTION,...]] [--no-pkg-check] [--no-kill] TARGET [ARG,...]
+
+Build ALL targets.
+Execute 'fx shell killall TARGET'.
+Execute 'fx shell run TARGET [ARGS].
+
+ --no-build do not execute a build
+ --no-pkg-check do not check for a package server
+ --no-kill do not kill all instances of matching components
+
+NINJA OPTION
+The following ninja options are passed to the build if invoked:
+ -C, -f, -j, -k, -l, -t, -w.
+See fx ninja --help for more information on these flags.
+
+TARGET is any form that 'run' on the target device accepts, as such it may
+be a package url, or a non-ambiguous short-form.
+ARG is passed to target without interpretation. All arguments after TARGET
+are passed to TARGET.
+```
+
+[run source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/run)
diff --git a/tools/fx/cmd/set.md b/tools/fx/cmd/set.md
index 6f0d976..ba30e57 100644
--- a/tools/fx/cmd/set.md
+++ b/tools/fx/cmd/set.md
@@ -53,9 +53,6 @@
attempts to make builds faster using remote build
servers. Defaults to detecting whether goma has been
set up via `fx goma`.
- --cxx-rbe If set, use reclient (RBE) to build C++ targets.
- This takes precedence over --goma.
- Default: disabled
--rust-rbe If set, use the remote backend (RBE) service for building
Rust targets. RBE offloads work onto remote servers and
offers caching benefits to accelerate builds.
@@ -107,10 +104,7 @@
produced by the build. Multiple labels can be
provided delimited by commas or the --with-host
argument can be provided multiple times.
- --cargo-toml-gen Enable generation of Cargo.toml files.
- --fint-params-path Used to specify a path to a fint parameters file, as
- selected by `fx repro`. If set, no other flags that
- influence the build configuration should be set.
+ --cargo-toml-gen Enable generation of Cargo.toml files
--dev Always recompile fx-set from source.
Example:
diff --git a/tools/fx/cmd/size-check.md b/tools/fx/cmd/size-check.md
deleted file mode 100644
index 7e92bb0..0000000
--- a/tools/fx/cmd/size-check.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# fx size-check
-
-Convenience wrapper for running the product size checker.
-
-```none
-usage: fx size-check
-
-Convenience wrapper for running the product size checker.
-```
-
-[size-check source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/size-check)
diff --git a/tools/fx/cmd/symbol-index.md b/tools/fx/cmd/symbol-index.md
index c48641a..1bcf786 100644
--- a/tools/fx/cmd/symbol-index.md
+++ b/tools/fx/cmd/symbol-index.md
@@ -1,9 +1,44 @@
# fx symbol-index
-(deprecated) manipulate the symbol-index file
+manipulate the symbol-index file
```none
-No help found. Try `fx symbol-index -h`
+"symbol-index" is a file used by debugging tools (zxdb, fidlcat, symbolizer) to
+locate all debugging symbols from different source code checkouts on a local
+machine. It's normally located at ~/.fuchsia/debug/symbol-index.
+
+This script interacts with a symbol-index file.
+
+Usage: fx symbol-index <verb> [<arguments> ...]
+
+Available verbs:
+
+ list
+ Lists all paths in symbol-index.
+
+ register
+ Add all symbols in the current Fuchsia checkout to symbol-index.
+
+ add <symbol path> [ <build directory> ]
+ Adds a new symbol path to symbol-index. A symbol path could be either a
+ a text file in "ids.txt" format, or a directory in ".build-id" structure.
+ An optional build directory could be supplemented, which is used by zxdb
+ to locate the source code. If the symbol path is already in symbol-index,
+ no changes will be made regardless of the optional build directory.
+
+ add-all [ <input file> ]
+ Reads the input and adds all symbol paths with optional build directories.
+ The input file can contain multiple lines, each describing a symbol path.
+ An optional build directory could be supplemented and separated from the
+ symbol path with whitespaces. Relative paths will be resolved based on
+ the input file. Empty lines and lines starting with "#" will be ignored.
+ If the input file is not specified, the input will be read from the stdin.
+
+ remove <symbol path>
+ Removes a symbol path from symbol-index.
+
+ purge
+ Removes all non-existent paths from symbol-index.
```
[symbol-index source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/symbol-index)
diff --git a/tools/fx/cmd/update-3p-owners.md b/tools/fx/cmd/update-3p-owners.md
deleted file mode 100644
index 6b5fd74..0000000
--- a/tools/fx/cmd/update-3p-owners.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# fx update-3p-owners
-
-updates OWNERS files for third\_party dependencies
-
-```none
-usage: fx update-3p-owners [--num-threads N]
- [--rust-only | --integration-only]
- [--skip-rustc-3p-update]
- [--skip-existing]
-
-Updates OWNERS files for projects, based on gn target references. For any
-given project, the tool adds as owners the owners of the projects that depend
-on that project.
-
-By default, the tool updates OWNERS for:
- - third_party/rust_crates/vendor/*, for Rust crates specified in
- third_party/rust_crates/Cargo.toml
- - integration third party projects specified in
- integration/third_party/flower.
-
-Arguments:
---num-threads N: run on N threads.
-
---rust-only: update OWNERS files only for Rust crates,
- specified in third_party/rust_crates/Cargo.toml.
-
---integration-only: update OWNERS files only for projects specified
- in integration/third_party/flower.
-
---skip-existing: only generate OWNERS files for projects missing
- owners; does not update exiting OWNERS files.
-
---skip-rustc-3p-update: skip updating rustc_library and rustc_binary
- third_party dependencies.
-
-See https://fuchsia.dev/fuchsia-src/development/languages/rust/third_party.md
-for more details.
-```
-
-[update-3p-owners source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/update-3p-owners)
diff --git a/tools/fx/cmd/update-rust-3p-owners.md b/tools/fx/cmd/update-rust-3p-owners.md
new file mode 100644
index 0000000..a8d09df
--- /dev/null
+++ b/tools/fx/cmd/update-rust-3p-owners.md
@@ -0,0 +1,15 @@
+# fx update-rust-3p-owners
+
+updates OWNERS files for Rust third\_party dependencies
+
+```none
+usage: fx update-rust-3p-owners [--no-vendor-and-gn-update] [--num-threads N]
+
+Updates third_party/rust_crates/vendor/*/OWNERS based on the contents of
+third_party/rust_crates/Cargo.toml
+
+See https://fuchsia.dev/fuchsia-src/development/languages/rust/third_party.md
+for more details.
+```
+
+[update-rust-3p-owners source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/update-rust-3p-owners)
diff --git a/tools/fx/cmd/validate-sdk.md b/tools/fx/cmd/validate-sdk.md
deleted file mode 100644
index 07613ca..0000000
--- a/tools/fx/cmd/validate-sdk.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# fx validate-sdk
-
-Attempt to build a few known SDK-based OOT repos based on a core SDK
-
-```none
-
-This command attempts to build some known SDK-based OOT repos with an SDK
-produced with the local Fuchsia tree and build configuration.
-
-Usage: fx validate-sdk [--local-bazel-rules] [--keep-tmp] [[REPO/CLNUM/PATCHSET] ...]
-
-It first runs the equivalent of 'fx build sdk:core sdk:driver'
-
-Then for each SDK-based repo from the list:
- sdk-samples/getting-started
- sdk-samples/drivers
- sdk-samples/fortune-teller
- it will clone the corresponding repo and attempt to build it with
-the local SDK produced by 'fx build sdk:core sdk:driver'
-
-Given that some of these repos, like getting-started and drivers, only
-update their SDK every few weeks, there will likely be a WIP roller CL
-that you may want to patch before attempting to build.
-If you want to patch a CL from these repos before validating the SDK,
-you can use the [REPO/CL/PATCHSET] syntax:
-
-
- --local-bazel-rules Use the version of the sdk-integration repo in
- the local Fuchsia tree (//third_party/sdk-integration)
- instead of the version checked-in on the samples.
- With this option, the in-tree sdk-integration will replace both
- the checked-in and patched-in sdk-integration.
-
- --keep-tmp Do not delete the temporary directories used to fetch and
- build the samples when they fail to build. This is useful
- to debug and iterate on fixes without having to download the samples again.
- If the build succeeds, the temp dirs will be deleted
- regardless of this flag.
-
- Examples:
- fx validate-sdk
- fx validate-sdk --local-bazel-rules
- fx validate-sdk drivers/715716/9 getting-started/691515/11
- fx validate-sdk --keep-tmp
-```
-
-[validate-sdk source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/contrib/validate-sdk)
diff --git a/tools/fx/index.md b/tools/fx/index.md
index 922db77..2d0939c 100644
--- a/tools/fx/index.md
+++ b/tools/fx/index.md
@@ -18,12 +18,9 @@
------- | -------- | -----------
[add-update-source](cmd/add-update-source.md) | [Software delivery](software_delivery.md) | register dev host as target's update source
[args](cmd/args.md) | [Build](build.md) | manually edit args.gn for the current build directory
-[bazel](cmd/bazel.md) | [Build](build.md) | Run experimental Bazel build for Fuchsia platform tree
[bootfs-size-report](cmd/bootfs-size-report.md) | [Run, inspect and debug](run_inspect_and_debug.md) | produce an uncompressed size report from a ZBI
[build](cmd/build.md) | [Build](build.md) | Run Ninja to build Fuchsia
-[build-metrics](cmd/build-metrics.md) | [Other](other.md) | manage build metrics configuration
[build-push](cmd/build-push.md) | [Software delivery](software_delivery.md) | DEPRECATED! build Fuchsia and push to device
-[check-goldens](cmd/check-goldens.md) | [Source tree](source_tree.md) | Checks all golden file comparisons in the GN build graph.
[cipd](cmd/cipd.md) | [Source tree](source_tree.md) | run the cipd command line tool
[clean](cmd/clean.md) | [Build](build.md) | clean the current Fuchsia build artifacts
[clean-build](cmd/clean-build.md) | [Build](build.md) | Clean the build directory and then perform a full build
@@ -32,6 +29,7 @@
[cmc](cmd/cmc.md) | [Build](build.md) | Component manifest compiler
[cp](cmd/cp.md) | [Device management](device_management.md) | copy a file to/from a target device
[create](cmd/create.md) | [Source tree](source_tree.md) | Scaffold new projects
+[emu](cmd/emu.md) | [Run, inspect and debug](run_inspect_and_debug.md) | start fuchsia in an emulator
[emu-remote](cmd/emu-remote.md) | [Other](other.md) | Remotely run emulator
[exec](cmd/exec.md) | [Other](other.md) | read the current build config, then exec
[fargo](cmd/fargo.md) | [Build](build.md) | Fargo is a prototype Fuchsia-specific wrapper around Cargo
@@ -86,8 +84,8 @@
[report-bug](cmd/report-bug.md) | [Software delivery](software_delivery.md) | report a bug for an fx command
[repro](cmd/repro.md) | [Build](build.md) | Locally replicate the result of infra builds and tests
[rfc](cmd/rfc.md) | [Source tree](source_tree.md) | Scaffold new RFCs
+[run](cmd/run.md) | [Software delivery](software_delivery.md) | build Fuchsia and push to device
[run-host-tests](cmd/run-host-tests.md) | [Test](test.md) | DEPRECATED! build and run tests on host
-[run-in-build-dir](cmd/run-in-build-dir.md) | [Build](build.md) | Run the given command at the root of the current build directory
[run-netboot](cmd/run-netboot.md) | [Run, inspect and debug](run_inspect_and_debug.md) | start fuchsia in qemu via netboot
[run-test](cmd/run-test.md) | [Test](test.md) | DEPRECATED! build a test package and run on target.
[run-test-component](cmd/run-test-component.md) | [Test](test.md) | DEPRECATED! build a test package and run on target.
@@ -137,20 +135,22 @@
[check-deps](cmd/check-deps.md) | [Build](build.md) | checks dependency graph in areas
[check-licenses](cmd/check-licenses.md) | [Documentation](documentation.md) | analyze the license state of a given package or directory
[clang-tidy](cmd/clang-tidy.md) | [Source tree](source_tree.md) | runs clang-tidy on specified files
-[clippy](cmd/clippy.md) | [Other](other.md) | Runs a Rust helper script inside the fx environment under the lock
+[clippy](cmd/clippy.md) | [Other](other.md) | Runs a Rust helper script inside the fx environment
[clippy](cmd/clippy.md) | [Diagnostic](diagnostic.md) |
[compdb](cmd/compdb.md) | [Build](build.md) | DEPRECATED
+[component-graph](cmd/component-graph.md) | [Run, inspect and debug](run_inspect_and_debug.md) | start component graph server to map component topology
+[component-surveyor](cmd/component-surveyor.md) | [Other](other.md) | produce a dump of v1 components in CSV form.
[core-tests](cmd/core-tests.md) | [Test](test.md) | run zircon core-tests
-[coverage](cmd/coverage.md) | [Test](test.md) | Runs test and exports coverage data.
[cpu-stats](cmd/cpu-stats.md) | [Run, inspect and debug](run_inspect_and_debug.md) | generate a report of CPU stats from a snapshot
[dart-remote-test](cmd/dart-remote-test.md) | [Test](test.md) | runs a single remote test target through //scripts/run-dart-action.py
+[debug](cmd/debug.md) | [Run, inspect and debug](run_inspect_and_debug.md) | (deprecated) run the debug agent on target and connect to it with zxdb
[dis](cmd/dis.md) | [Diagnostic](diagnostic.md) | Dumps disassembly for binaries from the build.
[disk-extract-serial-log](cmd/disk-extract-serial-log.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Extract disk image from serial logs.
[exec-host-tests](cmd/exec-host-tests.md) | [Test](test.md) |
[extract-pprof](cmd/extract-pprof.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Extract pprof data from inspect.json
[extract-zbi](cmd/extract-zbi.md) | [Other](other.md) |
[ffx](cmd/ffx.md) | [Other](other.md) | execute ffx - future fx
-[fidlcat](cmd/fidlcat.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Deprecated, please use "ffx debug fidl"
+[fidlcat](cmd/fidlcat.md) | [Run, inspect and debug](run_inspect_and_debug.md) | (deprecated) run fidlcat on given target.
[fidldoc](cmd/fidldoc.md) | [Documentation](documentation.md) | generate documentation for FIDL
[fidltags](cmd/fidltags.md) | [Other](other.md) | generate tags for .fidl files
[force-ota-from-devhost](cmd/force-ota-from-devhost.md) | [Software delivery](software_delivery.md) | force an Over The Air system update from devhost (reboots!)
@@ -175,6 +175,7 @@
[overnet](cmd/overnet.md) | [Run, inspect and debug](run_inspect_and_debug.md) | start an overnet host-pipe to target device
[pending-commits](cmd/pending-commits.md) | [Source tree](source_tree.md) | view commits not yet published to global integration
[qemu-cipd-ensure](cmd/qemu-cipd-ensure.md) | [Other](other.md) | Generate CIPD files to download the current QEMU package.
+[regen-goldens](cmd/regen-goldens.md) | [Source tree](source_tree.md) | regenerates golden files in the source tree
[remove-update-source](cmd/remove-update-source.md) | [Software delivery](software_delivery.md) | deregisters dev host as target's update source
[roll-compiler](cmd/roll-compiler.md) | [Other](other.md) |
[run-dart-action](cmd/run-dart-action.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Run Dart actions (analysis, test, target-test)
@@ -195,23 +196,21 @@
[setup-usb-ethernet](cmd/setup-usb-ethernet.md) | [Other](other.md) | Setup udev rules for USB CDC ethernet
[show-package](cmd/show-package.md) | [Software delivery](software_delivery.md) | lists package contents
[shush](cmd/shush.md) | [Source tree](source_tree.md) | silence rust lints with allows or compiler suggested fixes
-[size-check](cmd/size-check.md) | [Other](other.md) | Convenience wrapper for running the product size checker.
[smoke-test](cmd/smoke-test.md) | [Other](other.md) | Runs a Python helper script inside the fx environment
[smoke-test](cmd/smoke-test.md) | [Test](test.md) | Finds and runs tests affected by the current change.
[snapshot](cmd/snapshot.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Obtain and parse a snapshot from a connected target.
[sniff](cmd/sniff.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Fuchsia packet capture and display tool
[sniff.py](cmd/sniff.py.md) | [Other](other.md) |
-[symbol-index](cmd/symbol-index.md) | [Build](build.md) | (deprecated) manipulate the symbol-index file
+[symbol-index](cmd/symbol-index.md) | [Build](build.md) | manipulate the symbol-index file
[sync-from-stem](cmd/sync-from-stem.md) | [Source tree](source_tree.md) | sync integration and deps to a state matching fuchsia.git state
[test-stats](cmd/test-stats.md) | [Test](test.md) | Query and calculate test stats.
[test-stats.py](cmd/test-stats.py.md) | [Test](test.md) | Query and calculate test stats.
[traceutil](cmd/traceutil.md) | [Run, inspect and debug](run_inspect_and_debug.md) | Fuchsia tracing utility
[triage](cmd/triage.md) | [Run, inspect and debug](run_inspect_and_debug.md) | generate a report of error conditions
[unarchive-package](cmd/unarchive-package.md) | [Software delivery](software_delivery.md) | unarchive a Fuchsia package archive in FAR format
-[update-3p-owners](cmd/update-3p-owners.md) | [Source tree](source_tree.md) | updates OWNERS files for third\_party dependencies
[update-rust-3p-outdated](cmd/update-rust-3p-outdated.md) | [Source tree](source_tree.md) | updates external Rust dependencies with latest from crates.io
+[update-rust-3p-owners](cmd/update-rust-3p-owners.md) | [Source tree](source_tree.md) | updates OWNERS files for Rust third\_party dependencies
[update-rustc-third-party](cmd/update-rustc-third-party.md) | [Source tree](source_tree.md) | updates rustc\_library and rustc\_binary third\_party dependencies
-[validate-sdk](cmd/validate-sdk.md) | [Build](build.md) | Attempt to build a few known SDK-based OOT repos based on a core SDK
[wipe-partition-tables](cmd/wipe-partition-tables.md) | [Other](other.md) | run bootserver for wiping partition tables
[zbi_json_to_d3js.py](cmd/zbi_json_to_d3js.py.md) | [Other](other.md) |
[zedmon](cmd/zedmon.md) | [Other](other.md) | run zedmon client
diff --git a/tools/fx/other.md b/tools/fx/other.md
index 619d6df..981c6ff 100644
--- a/tools/fx/other.md
+++ b/tools/fx/other.md
@@ -2,7 +2,6 @@
Command | Description
------- | -----------
-[build-metrics](cmd/build-metrics.md) | manage build metrics configuration
[emu-remote](cmd/emu-remote.md) | Remotely run emulator
[exec](cmd/exec.md) | read the current build config, then exec
[flash-remote](cmd/flash-remote.md) | Remotely build, fetch and flash
@@ -22,7 +21,8 @@
[vendor](cmd/vendor.md) | forward commands to vendor/\*/scripts/devshell
[arm-esr](cmd/arm-esr.md) | decode ARM Exception Syndrome Register values
[bisect-rustc](cmd/bisect-rustc.md) |
-[clippy](cmd/clippy.md) | Runs a Rust helper script inside the fx environment under the lock
+[clippy](cmd/clippy.md) | Runs a Rust helper script inside the fx environment
+[component-surveyor](cmd/component-surveyor.md) | produce a dump of v1 components in CSV form.
[extract-zbi](cmd/extract-zbi.md) |
[ffx](cmd/ffx.md) | execute ffx - future fx
[fidltags](cmd/fidltags.md) | generate tags for .fidl files
@@ -39,7 +39,6 @@
[set-relay](cmd/set-relay.md) | Actuates the state of an external relay by writing a single byte to \|tty\|.
[setup-go](cmd/setup-go.md) | Set up the checkout for Go development.
[setup-usb-ethernet](cmd/setup-usb-ethernet.md) | Setup udev rules for USB CDC ethernet
-[size-check](cmd/size-check.md) | Convenience wrapper for running the product size checker.
[smoke-test](cmd/smoke-test.md) | Runs a Python helper script inside the fx environment
[sniff.py](cmd/sniff.py.md) |
[wipe-partition-tables](cmd/wipe-partition-tables.md) | run bootserver for wiping partition tables
diff --git a/tools/fx/other_toc.yaml b/tools/fx/other_toc.yaml
index eaeeae7..4f6e348 100644
--- a/tools/fx/other_toc.yaml
+++ b/tools/fx/other_toc.yaml
@@ -1,6 +1,4 @@
toc:
-- title: "build-metrics"
- path: /reference/tools/fx/cmd/build-metrics.md
- title: "emu-remote"
path: /reference/tools/fx/cmd/emu-remote.md
- title: "exec"
@@ -41,6 +39,8 @@
path: /reference/tools/fx/cmd/bisect-rustc.md
- title: "clippy"
path: /reference/tools/fx/cmd/clippy.md
+- title: "component-surveyor"
+ path: /reference/tools/fx/cmd/component-surveyor.md
- title: "extract-zbi"
path: /reference/tools/fx/cmd/extract-zbi.md
- title: "ffx"
@@ -73,8 +73,6 @@
path: /reference/tools/fx/cmd/setup-go.md
- title: "setup-usb-ethernet"
path: /reference/tools/fx/cmd/setup-usb-ethernet.md
-- title: "size-check"
- path: /reference/tools/fx/cmd/size-check.md
- title: "smoke-test"
path: /reference/tools/fx/cmd/smoke-test.md
- title: "sniff.py"
diff --git a/tools/fx/run_inspect_and_debug.md b/tools/fx/run_inspect_and_debug.md
index 6a9df68..e19d547 100644
--- a/tools/fx/run_inspect_and_debug.md
+++ b/tools/fx/run_inspect_and_debug.md
@@ -3,6 +3,7 @@
Command | Description
------- | -----------
[bootfs-size-report](cmd/bootfs-size-report.md) | produce an uncompressed size report from a ZBI
+[emu](cmd/emu.md) | start fuchsia in an emulator
[host-tool](cmd/host-tool.md) | run a host tool produced by the build
[klog](cmd/klog.md) | listen for kernel logs
[log](cmd/log.md) | listen for logs from the on-device log\_listener
@@ -14,10 +15,12 @@
[binutils](cmd/binutils.md) | Provides a shortcut to the prebuilt LLVM binutils tools
[blobstats](cmd/blobstats.md) | compute some blobfs statistics from the build
[bt-snoop-from-snapshot](cmd/bt-snoop-from-snapshot.md) | extract a snoop log from a snapshot as pcap formatted data
+[component-graph](cmd/component-graph.md) | start component graph server to map component topology
[cpu-stats](cmd/cpu-stats.md) | generate a report of CPU stats from a snapshot
+[debug](cmd/debug.md) | (deprecated) run the debug agent on target and connect to it with zxdb
[disk-extract-serial-log](cmd/disk-extract-serial-log.md) | Extract disk image from serial logs.
[extract-pprof](cmd/extract-pprof.md) | Extract pprof data from inspect.json
-[fidlcat](cmd/fidlcat.md) | Deprecated, please use "ffx debug fidl"
+[fidlcat](cmd/fidlcat.md) | (deprecated) run fidlcat on given target.
[fuzz](cmd/fuzz.md) | run a fuzz test on target a device
[gdb](cmd/gdb.md) | Run GDB, the GNU DeBugger.
[gnu](cmd/gnu.md) | Provides a shortcut to the prebuilt GNU diagnostic tools
diff --git a/tools/fx/run_inspect_and_debug_toc.yaml b/tools/fx/run_inspect_and_debug_toc.yaml
index aa3afaa..a85991c 100644
--- a/tools/fx/run_inspect_and_debug_toc.yaml
+++ b/tools/fx/run_inspect_and_debug_toc.yaml
@@ -1,6 +1,8 @@
toc:
- title: "bootfs-size-report"
path: /reference/tools/fx/cmd/bootfs-size-report.md
+- title: "emu"
+ path: /reference/tools/fx/cmd/emu.md
- title: "host-tool"
path: /reference/tools/fx/cmd/host-tool.md
- title: "klog"
@@ -23,8 +25,12 @@
path: /reference/tools/fx/cmd/blobstats.md
- title: "bt-snoop-from-snapshot"
path: /reference/tools/fx/cmd/bt-snoop-from-snapshot.md
+- title: "component-graph"
+ path: /reference/tools/fx/cmd/component-graph.md
- title: "cpu-stats"
path: /reference/tools/fx/cmd/cpu-stats.md
+- title: "debug"
+ path: /reference/tools/fx/cmd/debug.md
- title: "disk-extract-serial-log"
path: /reference/tools/fx/cmd/disk-extract-serial-log.md
- title: "extract-pprof"
diff --git a/tools/fx/software_delivery.md b/tools/fx/software_delivery.md
index 787022f..cde3b0f 100644
--- a/tools/fx/software_delivery.md
+++ b/tools/fx/software_delivery.md
@@ -13,6 +13,7 @@
[pave-zedboot](cmd/pave-zedboot.md) | run bootserver for paving zedboot
[push-package](cmd/push-package.md) | DEPRECATED! push packages to a device
[report-bug](cmd/report-bug.md) | report a bug for an fx command
+[run](cmd/run.md) | build Fuchsia and push to device
[serve](cmd/serve.md) | start `pave` and `serve-updates` in a single command
[serve-updates](cmd/serve-updates.md) | start the update server and attach to a running fuchsia device
[update](cmd/update.md) | DEPRECATED! [deprecated] alias for fx ota
diff --git a/tools/fx/software_delivery_toc.yaml b/tools/fx/software_delivery_toc.yaml
index bca2efb..01ed85d 100644
--- a/tools/fx/software_delivery_toc.yaml
+++ b/tools/fx/software_delivery_toc.yaml
@@ -21,6 +21,8 @@
path: /reference/tools/fx/cmd/push-package.md
- title: "report-bug"
path: /reference/tools/fx/cmd/report-bug.md
+- title: "run"
+ path: /reference/tools/fx/cmd/run.md
- title: "serve"
path: /reference/tools/fx/cmd/serve.md
- title: "serve-updates"
diff --git a/tools/fx/source_tree.md b/tools/fx/source_tree.md
index 34a1d4a..cd8a7a5 100644
--- a/tools/fx/source_tree.md
+++ b/tools/fx/source_tree.md
@@ -2,7 +2,6 @@
Command | Description
------- | -----------
-[check-goldens](cmd/check-goldens.md) | Checks all golden file comparisons in the GN build graph.
[cipd](cmd/cipd.md) | run the cipd command line tool
[create](cmd/create.md) | Scaffold new projects
[jiri](cmd/jiri.md) | multi-purpose tool for multi-repo development.
@@ -14,10 +13,11 @@
[grep](cmd/grep.md) | print lines in the Fuchsia sources matching the given pattern
[lint](cmd/lint.md) | runs source linters on modified files
[pending-commits](cmd/pending-commits.md) | view commits not yet published to global integration
+[regen-goldens](cmd/regen-goldens.md) | regenerates golden files in the source tree
[rustfmt](cmd/rustfmt.md) | format Rust code
[set-petal](cmd/set-petal.md) | configure jiri to manage a specific petal
[shush](cmd/shush.md) | silence rust lints with allows or compiler suggested fixes
[sync-from-stem](cmd/sync-from-stem.md) | sync integration and deps to a state matching fuchsia.git state
-[update-3p-owners](cmd/update-3p-owners.md) | updates OWNERS files for third\_party dependencies
[update-rust-3p-outdated](cmd/update-rust-3p-outdated.md) | updates external Rust dependencies with latest from crates.io
+[update-rust-3p-owners](cmd/update-rust-3p-owners.md) | updates OWNERS files for Rust third\_party dependencies
[update-rustc-third-party](cmd/update-rustc-third-party.md) | updates rustc\_library and rustc\_binary third\_party dependencies
diff --git a/tools/fx/source_tree_toc.yaml b/tools/fx/source_tree_toc.yaml
index 8c0505f..f519151 100644
--- a/tools/fx/source_tree_toc.yaml
+++ b/tools/fx/source_tree_toc.yaml
@@ -1,6 +1,4 @@
toc:
-- title: "check-goldens"
- path: /reference/tools/fx/cmd/check-goldens.md
- title: "cipd"
path: /reference/tools/fx/cmd/cipd.md
- title: "create"
@@ -23,6 +21,8 @@
path: /reference/tools/fx/cmd/lint.md
- title: "pending-commits"
path: /reference/tools/fx/cmd/pending-commits.md
+- title: "regen-goldens"
+ path: /reference/tools/fx/cmd/regen-goldens.md
- title: "rustfmt"
path: /reference/tools/fx/cmd/rustfmt.md
- title: "set-petal"
@@ -31,9 +31,9 @@
path: /reference/tools/fx/cmd/shush.md
- title: "sync-from-stem"
path: /reference/tools/fx/cmd/sync-from-stem.md
-- title: "update-3p-owners"
- path: /reference/tools/fx/cmd/update-3p-owners.md
- title: "update-rust-3p-outdated"
path: /reference/tools/fx/cmd/update-rust-3p-outdated.md
+- title: "update-rust-3p-owners"
+ path: /reference/tools/fx/cmd/update-rust-3p-owners.md
- title: "update-rustc-third-party"
path: /reference/tools/fx/cmd/update-rustc-third-party.md
diff --git a/tools/fx/test.md b/tools/fx/test.md
index 4503352..8e24119 100644
--- a/tools/fx/test.md
+++ b/tools/fx/test.md
@@ -9,7 +9,6 @@
[test](cmd/test.md) | Entry point for all Fuchsia tests (host, target and end-to-end)
[testgen](cmd/testgen.md) | Component integration test auto-generator
[core-tests](cmd/core-tests.md) | run zircon core-tests
-[coverage](cmd/coverage.md) | Runs test and exports coverage data.
[dart-remote-test](cmd/dart-remote-test.md) | runs a single remote test target through //scripts/run-dart-action.py
[exec-host-tests](cmd/exec-host-tests.md) |
[run-e2e-tests](cmd/run-e2e-tests.md) | run e2e tests
diff --git a/tools/fx/test_toc.yaml b/tools/fx/test_toc.yaml
index b0351d7..fc03062 100644
--- a/tools/fx/test_toc.yaml
+++ b/tools/fx/test_toc.yaml
@@ -13,8 +13,6 @@
path: /reference/tools/fx/cmd/testgen.md
- title: "core-tests"
path: /reference/tools/fx/cmd/core-tests.md
-- title: "coverage"
- path: /reference/tools/fx/cmd/coverage.md
- title: "dart-remote-test"
path: /reference/tools/fx/cmd/dart-remote-test.md
- title: "exec-host-tests"
