From fb598f6010454da7be0001cb428928afae6a7d00 Mon Sep 17 00:00:00 2001 From: Gregory Comer Date: Mon, 17 Feb 2025 21:31:50 -0800 Subject: [PATCH 1/2] Move cmake and faq docs to new location --- docs/source/index.rst | 2 ++ ...-compilation.md => using-executorch-building-from-source.md} | 0 .../{getting-started-faqs.md => using-executorch-faqs.md} | 2 +- docs/source/using-executorch-troubleshooting.md | 2 +- 4 files changed, 4 insertions(+), 2 deletions(-) rename docs/source/{runtime-build-and-cross-compilation.md => using-executorch-building-from-source.md} (100%) rename docs/source/{getting-started-faqs.md => using-executorch-faqs.md} (99%) diff --git a/docs/source/index.rst b/docs/source/index.rst index 7d316664092..8ef6e1a90bb 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -90,6 +90,8 @@ Topics in this section will help you get started with ExecuTorch. using-executorch-ios using-executorch-cpp using-executorch-troubleshooting + using-executorch-faqs + using-executorch-building-from-source .. toctree:: :glob: diff --git a/docs/source/runtime-build-and-cross-compilation.md b/docs/source/using-executorch-building-from-source.md similarity index 100% rename from docs/source/runtime-build-and-cross-compilation.md rename to docs/source/using-executorch-building-from-source.md diff --git a/docs/source/getting-started-faqs.md b/docs/source/using-executorch-faqs.md similarity index 99% rename from docs/source/getting-started-faqs.md rename to docs/source/using-executorch-faqs.md index e103309f716..f2aaf4b8ee6 100644 --- a/docs/source/getting-started-faqs.md +++ b/docs/source/using-executorch-faqs.md @@ -1,4 +1,4 @@ -# FAQs and Common Issues +# Frequently Asked Questions This page summarizes frequently asked questions and provides guidance on issues that commonly occur when adopting ExecuTorch. diff --git a/docs/source/using-executorch-troubleshooting.md b/docs/source/using-executorch-troubleshooting.md index b2549dee578..406c1ed8347 100644 --- a/docs/source/using-executorch-troubleshooting.md +++ b/docs/source/using-executorch-troubleshooting.md @@ -1,3 +1,3 @@ -# Troubleshooting, Profiling, and Optimization +# Profiling and Debugging Placeholder for top-level troubleshooting, profiling, and devtool docs \ No newline at end of file From 8b1efc6759b610f235d37964c99737c72b45e4df Mon Sep 17 00:00:00 2001 From: Gregory Comer Date: Mon, 17 Feb 2025 21:50:35 -0800 Subject: [PATCH 2/2] Rename CMake build to Building from Source --- docs/source/using-executorch-building-from-source.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/using-executorch-building-from-source.md b/docs/source/using-executorch-building-from-source.md index 3574b76b6df..01ec05b1156 100644 --- a/docs/source/using-executorch-building-from-source.md +++ b/docs/source/using-executorch-building-from-source.md @@ -1,6 +1,6 @@ -# Building with CMake +# Building from Source -ExecuTorch uses [CMake](https://cmake.org/) as its primary build system. +ExecuTorch uses [CMake](https://cmake.org/) as the primary build system. Even if you don't use CMake directly, CMake can emit scripts for other format like Make, Ninja or Xcode. For information, see [cmake-generators(7)](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html).