From 06f8baf6dac86017b66eb1d5e89817cfa41eab89 Mon Sep 17 00:00:00 2001
From: Marta Rybczynska <marta.rybczynska@huawei.com>
Date: Fri, 8 Jul 2022 09:27:10 +0200
Subject: [PATCH] docs: add Debug Mode documentation
Add basic documentation for the debug mode.
Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com>
---
docs/debug-mode.rst | 34 ++++++++++++++++++++++++++++++++++
docs/index.rst | 3 ++-
2 files changed, 36 insertions(+), 1 deletion(-)
create mode 100644 docs/debug-mode.rst
diff --git a/docs/debug-mode.rst b/docs/debug-mode.rst
new file mode 100644
index 00000000..9547ad49
--- /dev/null
+++ b/docs/debug-mode.rst
@@ -0,0 +1,34 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. include:: definitions.rst
+
+.. _DebugMode:
+
+Debug Mode
+##########
+
+In some situations, you may want to compile an image with some additional tools
+and features for easier debugging. For this reason, |main_project_name|
+offers the debug mode.
+
+Images built with the `debug mode` enabled contain additional tools and allow
+to log in as root (which is disabled in the default images).
+
+To enable the `debug mode`, edit your ``local.conf`` and add:
+
+.. code-block:: console
+
+ INHERIT += "oniro-debug-linux"
+
+For convenience, the section is already present commented-out in the template
+and you may uncoment it.
+
+When done, rebuild your image as usual. To go back to the production mode,
+comment the line out again and rebuild your image.
+
+.. Note::
+
+ Debug mode images are unsupported by the project and do not take part
+ of the release. They are provided for convenience only.
diff --git a/docs/index.rst b/docs/index.rst
index d9904419..802a2d7a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -40,4 +40,5 @@ Build System Guide
:caption: Troubleshoot
:maxdepth: 2
- fallback-devices-support
+ fallback-devices-support
+ debug-mode
--
GitLab