[docs] Devsite restructure phase 2 CL 01 - Move files out of zircon dir.
Move the files from the 'zircon' directory to the following categories
in the 'development' directory:
- benchmarking
- build
- components
- languages/c-cpp
- debugging
- (tools)/emulator
And update the _toc.yaml of the DEVELOPMENT section.
Change-Id: I772539ac7e62b16a467d20bf10363305fcfb8430
diff --git a/docs/development/_toc.yaml b/docs/development/_toc.yaml
index a8ddfc5..ce6fee8 100644
--- a/docs/development/_toc.yaml
+++ b/docs/development/_toc.yaml
@@ -4,61 +4,59 @@
toc:
- title: "Development"
path: /docs/development/README.md
+- heading: "Set up"
+- title: "Get source code"
+ section:
+ - include: /docs/development/source_code/_toc.yaml
+- title: "Set up hardware"
+ section:
+ - include: /docs/development/hardware/_toc.yaml
+- heading: "Build and run"
+- title: "Build"
+ section:
+ - include: /docs/development/build/_toc.yaml
+- heading: "Write code"
+- title: "Develop a kernel"
+ section:
+ - include: /docs/development/kernel/_toc.yaml
+- title: "Develop components"
+ section:
+ - include: /docs/development/components/_toc.yaml
+- title: "Inspect components"
+ section:
+ - include: /docs/development/inspect/_toc.yaml
+- title: "Develop using the SDK"
+ section:
+ - include: /docs/development/sdk/_toc.yaml
+- heading: "Test and debug"
+- title: "Test"
+ section:
+ - include: /docs/development/testing/_toc.yaml
+- title: "Benchmark"
+ section:
+ - include: /docs/development/benchmarking/_toc.yaml
+- title: "Debug"
+ section:
+ - include: /docs/development/debugging/_toc.yaml
+- title: "Trace"
+ section:
+ - include: /docs/development/tracing/_toc.yaml
+- heading: "Guides"
- title: "ABI"
section:
- include: /docs/development/abi/_toc.yaml
- title: "API"
section:
- include: /docs/development/api/_toc.yaml
-- title: "Benchmarking"
- section:
- - include: /docs/development/benchmarking/_toc.yaml
-- title: "Build"
- section:
- - include: /docs/development/build/_toc.yaml
-- title: "Supplying build-time configuration data to components"
- path: /docs/development/config_data.md
-- title: "Develop a kernel"
- section:
- - include: /docs/development/kernel/_toc.yaml
-- title: "Component Inspection"
- section:
- - include: /docs/development/inspect/_toc.yaml
-- title: "Hardware"
- section:
- - include: /docs/development/hardware/_toc.yaml
-- title: "Internationalization"
- section:
- - include: /docs/development/internationalization/_toc.yaml
- title: "Languages"
section:
- include: /docs/development/languages/_toc.yaml
-- title: "SDK"
+- title: "Internationalization"
section:
- - include: /docs/development/sdk/_toc.yaml
-- title: "Source code"
- section:
- - include: /docs/development/source_code/_toc.yaml
-- title: "Testing"
- section:
- - include: /docs/development/testing/_toc.yaml
-- title: "Tracing"
- section:
- - include: /docs/development/tracing/_toc.yaml
+ - include: /docs/development/internationalization/_toc.yaml
- title: "Workflows"
section:
- include: /docs/development/workflows/_toc.yaml
- title: "Tools"
section:
- - title: "Fidlcat"
- section:
- - include: /docs/development/fidl_inspecting/_toc.yaml
- - title: "System monitor"
- section:
- - include: /docs/development/system_monitor/_toc.yaml
- - title: "Debugger"
- section:
- - include: /docs/development/debugger/_toc.yaml
-- title: "Editors"
- section:
- - include: /docs/development/editors/_toc.yaml
+ - include: /docs/development/tools/_toc.yaml
diff --git a/docs/development/benchmarking/_toc.yaml b/docs/development/benchmarking/_toc.yaml
index f0c0ccb..f974572 100644
--- a/docs/development/benchmarking/_toc.yaml
+++ b/docs/development/benchmarking/_toc.yaml
@@ -10,3 +10,5 @@
path: /docs/development/benchmarking/running_on_ci.md
- title: "Trace-based benchmarking"
path: /docs/development/benchmarking/trace_based_benchmarking.md
+- title: "Microbenchmarks"
+ path: /docs/development/benchmarking/microbenchmarks.md
diff --git a/docs/zircon/benchmarks/microbenchmarks.md b/docs/development/benchmarking/microbenchmarks.md
similarity index 100%
rename from docs/zircon/benchmarks/microbenchmarks.md
rename to docs/development/benchmarking/microbenchmarks.md
diff --git a/docs/development/build/_toc.yaml b/docs/development/build/_toc.yaml
index 23fcf42..4f80e3f 100644
--- a/docs/development/build/_toc.yaml
+++ b/docs/development/build/_toc.yaml
@@ -20,5 +20,9 @@
path: /docs/development/build/variants.md
- title: "Bundles"
path: /docs/development/build/bundles.md
+- title: "A short introduction to GN"
+ path: /docs/development/build/intro.md
+- title: "GN in Zircon"
+ path: /docs/development/build/zircon_gn.md
- title: "GN build arguments"
path: https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/docs/gen/build_arguments.md
diff --git a/docs/zircon/gn/intro.md b/docs/development/build/intro.md
similarity index 100%
rename from docs/zircon/gn/intro.md
rename to docs/development/build/intro.md
diff --git a/docs/zircon/gn/zircon_gn.md b/docs/development/build/zircon_gn.md
similarity index 100%
rename from docs/zircon/gn/zircon_gn.md
rename to docs/development/build/zircon_gn.md
diff --git a/docs/development/components/_toc.yaml b/docs/development/components/_toc.yaml
new file mode 100644
index 0000000..b5b73a0
--- /dev/null
+++ b/docs/development/components/_toc.yaml
@@ -0,0 +1,6 @@
+# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# before making changes to this file, and add a member of the fuchsia.dev
+# team as reviewer.
+toc:
+- title: "Supplying build-time configuration data to components"
+ path: /docs/development/components/config_data.md
diff --git a/docs/development/config_data.md b/docs/development/components/config_data.md
similarity index 100%
rename from docs/development/config_data.md
rename to docs/development/components/config_data.md
diff --git a/docs/development/debugging/_toc.yaml b/docs/development/debugging/_toc.yaml
new file mode 100644
index 0000000..55bc47c
--- /dev/null
+++ b/docs/development/debugging/_toc.yaml
@@ -0,0 +1,8 @@
+# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# before making changes to this file, and add a member of the fuchsia.dev
+# team as reviewer.
+toc:
+- title: "ACPI debugging"
+ path: /docs/development/debugging/acpi.md
+- title: "Debugging tips"
+ path: /docs/development/debugging/tips.md
diff --git a/docs/zircon/debugging/acpi.md b/docs/development/debugging/acpi.md
similarity index 100%
rename from docs/zircon/debugging/acpi.md
rename to docs/development/debugging/acpi.md
diff --git a/docs/zircon/debugging/tips.md b/docs/development/debugging/tips.md
similarity index 97%
rename from docs/zircon/debugging/tips.md
rename to docs/development/debugging/tips.md
index 713d5c2..8d3956bf 100644
--- a/docs/zircon/debugging/tips.md
+++ b/docs/development/debugging/tips.md
@@ -49,7 +49,7 @@
## Debugging the kernel with QEMU+GDB.
-See "Debugging the kernel with GDB" in [QEMU](../qemu.md) for
+See "Debugging the kernel with GDB" in [QEMU](/docs/development/emulator/qemu.md) for
documentation on debugging zircon with QEMU+GDB.
[fuchsia-debugging-doc]: /docs/development/workflows/debugging.md
diff --git a/docs/development/emulator/_toc.yaml b/docs/development/emulator/_toc.yaml
new file mode 100644
index 0000000..6aa7202
--- /dev/null
+++ b/docs/development/emulator/_toc.yaml
@@ -0,0 +1,6 @@
+# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# before making changes to this file, and add a member of the fuchsia.dev
+# team as reviewer.
+toc:
+- title: "QEMU"
+ path: /docs/development/emulator/qemu.md
diff --git a/docs/zircon/qemu.md b/docs/development/emulator/qemu.md
similarity index 100%
rename from docs/zircon/qemu.md
rename to docs/development/emulator/qemu.md
diff --git a/docs/development/languages/_toc.yaml b/docs/development/languages/_toc.yaml
index 1046633..2ba05ae 100644
--- a/docs/development/languages/_toc.yaml
+++ b/docs/development/languages/_toc.yaml
@@ -4,14 +4,14 @@
toc:
- title: "Overview"
path: /docs/development/languages
-- title: "Linting and formatting"
- path: /docs/development/languages/lint_and_format.md
-- title: "Supporting new languages"
+- title: "Configure editors"
section:
- - title: "Overview"
- path: /docs/development/languages/new/README.md
- - title: "Recommended structure to support Fuchsia"
- path: /docs/development/languages/new/structure.md
+ - include: /docs/development/editors/_toc.yaml
+- title: "Configure linters and formatter"
+ path: /docs/development/languages/lint_and_format.md
+- title: "Support new languages"
+ section:
+ - include: /docs/development/languages/new/_toc.yaml
- title: "C/C++"
section:
- include: /docs/development/languages/c-cpp/_toc.yaml
diff --git a/docs/development/languages/c-cpp/_toc.yaml b/docs/development/languages/c-cpp/_toc.yaml
index adb51d9..65e9d4f 100644
--- a/docs/development/languages/c-cpp/_toc.yaml
+++ b/docs/development/languages/c-cpp/_toc.yaml
@@ -22,3 +22,7 @@
path: /docs/development/languages/c-cpp/syslog.md
- title: "Perftest micro-benchmark library"
path: https://fuchsia.googlesource.com/fuchsia/+/master/zircon/system/ulib/perftest/README.md
+- title: "C++ in Zircon"
+ path: /docs/development/languages/c-cpp/cxx.md
+- title: "Compile time collections"
+ path: /docs/development/languages/c-cpp/compile_time_object_collections.md
diff --git a/docs/zircon/compile_time_object_collections.md b/docs/development/languages/c-cpp/compile_time_object_collections.md
similarity index 100%
rename from docs/zircon/compile_time_object_collections.md
rename to docs/development/languages/c-cpp/compile_time_object_collections.md
diff --git a/docs/zircon/cxx.md b/docs/development/languages/c-cpp/cxx.md
similarity index 98%
rename from docs/zircon/cxx.md
rename to docs/development/languages/c-cpp/cxx.md
index 4b6a10a..5d5a009 100644
--- a/docs/zircon/cxx.md
+++ b/docs/development/languages/c-cpp/cxx.md
@@ -287,7 +287,7 @@
## ZX
-ZX contains C++ wrappers for the Zircon [objects](objects) and
+ZX contains C++ wrappers for the Zircon [objects](/docs/zircon/objects.md) and
[syscalls](/docs/reference/syscalls/README.md). These wrappers provide type safety and move semantics
for handles but offer no opinion beyond what's in syscalls.abigen. At some
point in the future, we might autogenerate ZX from syscalls.abigen, similar to
@@ -316,7 +316,7 @@
implementation, we call that _hermetic C++_.
* The kernel itself could be said to be implemented in hermetic C++.
- * The [vDSO](vdso.md) is a shared library implemented in hermetic C++.
+ * The [vDSO](/docs/zircon/vdso.md) is a shared library implemented in hermetic C++.
* Fuchsia's [standard C library](/zircon/system/ulib/c), while largely implemented
in C, also uses hermetic C++ in its implementation.
* Most Fuchsia device drivers are implemented in hermetic C++.
diff --git a/docs/development/languages/new/_toc.yaml b/docs/development/languages/new/_toc.yaml
new file mode 100644
index 0000000..6ea1b63
--- /dev/null
+++ b/docs/development/languages/new/_toc.yaml
@@ -0,0 +1,8 @@
+# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# before making changes to this file, and add a member of the fuchsia.dev
+# team as reviewer.
+toc:
+- title: "Overview"
+ path: /docs/development/languages/new/README.md
+- title: "Recommended structure to support Fuchsia"
+ path: /docs/development/languages/new/structure.md
diff --git a/docs/development/tools/_toc.yaml b/docs/development/tools/_toc.yaml
new file mode 100644
index 0000000..bd6455f
--- /dev/null
+++ b/docs/development/tools/_toc.yaml
@@ -0,0 +1,16 @@
+# Please, read https://fuchsia.dev/fuchsia-src/contribute/best-practices/documentation_navigation_toc
+# before making changes to this file, and add a member of the fuchsia.dev
+# team as reviewer.
+toc:
+- title: "Fidlcat"
+ section:
+ - include: /docs/development/fidl_inspecting/_toc.yaml
+- title: "System monitor"
+ section:
+ - include: /docs/development/system_monitor/_toc.yaml
+- title: "Debugger"
+ section:
+ - include: /docs/development/debugger/_toc.yaml
+- title: "QEMU"
+ section:
+ - include: /docs/development/emulator/_toc.yaml
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 77e5f67..33f578f 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -119,7 +119,7 @@
### Boot from QEMU
If you don't have the supported hardware, you can run Fuchsia under emulation
-using [QEMU](/docs/zircon/qemu.md).
+using [QEMU](/docs/development/emulator/qemu.md).
Fuchsia includes prebuilt binaries for QEMU under `prebuilt/third_party/qemu`.
The `fx run` command will launch Zircon within QEMU, using the locally built
@@ -158,7 +158,7 @@
#### Enabling Network
-First, [configure](/docs/zircon/qemu.md#enabling_networking_under_qemu) a
+First, [configure](/docs/development/emulator/qemu.md#enabling_networking_under_qemu) a
virtual interface for QEMU's use.
Once this is done you can add the `-N` and `-u` flags to `fx run`:
diff --git a/docs/glossary.md b/docs/glossary.md
index 184f8c3..4e683a8 100644
--- a/docs/glossary.md
+++ b/docs/glossary.md
@@ -323,7 +323,7 @@
FBL is the Fuchsia Base Library, which is shared between kernel and userspace.
-- [Zircon C++](/docs/zircon/cxx.md)
+- [Zircon C++](/docs/development/languages/c-cpp/cxx.md)
#### **fdio** {#fdio}
diff --git a/docs/the-book/core_libraries.md b/docs/the-book/core_libraries.md
index 21b39ec..4965dcc 100644
--- a/docs/the-book/core_libraries.md
+++ b/docs/the-book/core_libraries.md
@@ -39,7 +39,7 @@
instance, slab allocation).
For more information about FBL,
-[read its overview](/docs/zircon/cxx.md#fbl).
+[read its overview](/docs/development/languages/c-cpp/cxx.md#fbl).
# FXL
diff --git a/docs/the-book/package_metadata.md b/docs/the-book/package_metadata.md
index 4d6bd1a..4e18070 100644
--- a/docs/the-book/package_metadata.md
+++ b/docs/the-book/package_metadata.md
@@ -210,7 +210,7 @@
The set of currently known features are as follows:
- `config-data`, which will provide any configuration data available to the
- package this component is in that was provided in the [config-data](/docs/development/config_data.md)
+ package this component is in that was provided in the [config-data](/docs/development/components/config_data.md)
package on the system.
- `introspection`, which requests access to introspect the system. The
diff --git a/docs/zircon/README.md b/docs/zircon/README.md
index 02e0f4c..f2a2bdd 100644
--- a/docs/zircon/README.md
+++ b/docs/zircon/README.md
@@ -27,7 +27,7 @@
+ [Getting Started](getting_started.md)
+ [Contributing Patches](/docs/contribute/contributing.md)
+ [`abigen` grammar](abigen/grammar.md)
-+ [GN in Zircon](gn/zircon_gn.md)
++ [GN in Zircon](/docs/development/build/zircon_gn.md)
+ [Concepts Overview](concepts.md)
+ [Kernel Objects](objects.md)
@@ -57,12 +57,12 @@
+ [Block device testing](block_device_testing.md)
+ [nand Testing](nand_testing.md)
-+ [Compile-time object collections](compile_time_object_collections.md)
-+ [ACPI debugging](debugging/acpi.md)
++ [Compile-time object collections](/docs/development/languages/c-cpp/compile_time_object_collections.md)
++ [ACPI debugging](/docs/development/debugging/acpi.md)
+ [Fuzzing the FIDL host tools](fuzzing_fidl.md)
+ [Entropy collection TODOs](entropy_collection_todos.md)
+ [Memory usage analysis tools](memory.md)
+ [Symbolizer](/docs/reference/kernel/symbolizer_markup.md)
+ [Relationship with LK](zx_and_lk.md)
-+ [Micro-benchmarks](benchmarks/microbenchmarks.md)
++ [Micro-benchmarks](/docs/development/benchmarking/microbenchmarks.md)
+ [Avoiding a problem with the SYSRET instruction](sysret_problem.md)
diff --git a/docs/zircon/_toc.yaml b/docs/zircon/_toc.yaml
index 78b7c47..d360375 100644
--- a/docs/zircon/_toc.yaml
+++ b/docs/zircon/_toc.yaml
@@ -8,10 +8,6 @@
- title: "Getting started"
path: /docs/zircon/getting_started.md
-- title: "Building zircon"
- section:
- - include: /docs/zircon/gn/_toc.yaml
-
- title: "Architecture support"
path: /docs/zircon/architecture_support.md
@@ -20,10 +16,6 @@
- title: "C++"
section:
- - title: "Overview"
- path: /docs/zircon/cxx.md
- - title: "Compile time collections"
- path: /docs/zircon/compile_time_object_collections.md
- title: "fit::promise<> guide"
path: /docs/zircon/fit_promise_guide.md
@@ -121,10 +113,6 @@
section:
- include: /docs/zircon/targets/_toc.yaml
-- title: "Debugging"
- section:
- - include: /docs/zircon/debugging/_toc.yaml
-
- title: "Testing"
section:
- title: "Overview"
@@ -153,18 +141,12 @@
- title: "Zircon and LK"
path: /docs/zircon/zx_and_lk.md
-- title: "Benchmarks"
- section:
- - include: /docs/zircon/benchmarks/_toc.yaml
-
- title: "Reference"
path: /docs/reference/README.md
+
- title: "Notes"
section:
- title: "Entropy collection TODOs"
path: /docs/zircon/entropy_collection_todos.md
- title: "Avoiding a problem with the SYSRET"
path: /docs/zircon/sysret_problem.md
-
-- title: "QEMU"
- path: /docs/zircon/qemu.md
diff --git a/docs/zircon/benchmarks/_toc.yaml b/docs/zircon/benchmarks/_toc.yaml
deleted file mode 100644
index 6db433b..0000000
--- a/docs/zircon/benchmarks/_toc.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-# Please, read https://fuchsia.dev/fuchsia-src/best-practices/documentation_navigation_toc
-# before making changes to this file, and add a member of the fuchsia.dev
-# team as reviewer.
-toc:
-- title: "Microbenchmarks"
- path: /docs/zircon/benchmarks/microbenchmarks.md
diff --git a/docs/zircon/debugging/_toc.yaml b/docs/zircon/debugging/_toc.yaml
deleted file mode 100644
index 65bee82..0000000
--- a/docs/zircon/debugging/_toc.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-# Please, read https://fuchsia.dev/fuchsia-src/best-practices/documentation_navigation_toc
-# before making changes to this file, and add a member of the fuchsia.dev
-# team as reviewer.
-toc:
-- title: "ACPI debugging"
- path: /docs/zircon/debugging/acpi.md
-- title: "Debugging tips"
- path: /docs/zircon/debugging/tips.md
diff --git a/docs/zircon/getting_started.md b/docs/zircon/getting_started.md
index 4fb6839..b397afb 100644
--- a/docs/zircon/getting_started.md
+++ b/docs/zircon/getting_started.md
@@ -70,7 +70,7 @@
You can skip this if you're only testing on actual hardware, but the emulator
is handy for quick local tests and generally worth having around.
-See [QEMU](qemu.md) for information on building and using QEMU with zircon.
+See [QEMU](/docs/development/emulator/qemu.md) for information on building and using QEMU with zircon.
## Build Toolchains (Optional)
@@ -238,7 +238,7 @@
## Debugging
For random tips on debugging in the zircon environment see
-[debugging](debugging/tips.md).
+[debugging](/docs/development/debugging/tips.md).
## Contribute changes
* See [contributing.md](/docs/contribute/contributing.md).
diff --git a/docs/zircon/gn/_toc.yaml b/docs/zircon/gn/_toc.yaml
deleted file mode 100644
index 3feb420..0000000
--- a/docs/zircon/gn/_toc.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-# Please, read https://fuchsia.dev/fuchsia-src/best-practices/documentation_navigation_toc
-# before making changes to this file, and add a member of the fuchsia.dev
-# team as reviewer.
-toc:
-- title: "A short introduction to GN"
- path: /docs/zircon/gn/intro.md
-- title: "GN in Zircon"
- path: /docs/zircon/gn/zircon_gn.md
