From 7711c553b27f08eede2a96205a249d80db03ca7f Mon Sep 17 00:00:00 2001 From: Erin Abicht Date: Tue, 18 Apr 2023 08:45:24 -0400 Subject: [PATCH] Basic debugging outline --- src/SUMMARY.md | 4 ++++ src/debugging/README.md | 7 +++++++ src/debugging/gdb.md | 1 + 3 files changed, 12 insertions(+) create mode 100644 src/debugging/README.md create mode 100644 src/debugging/gdb.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4f6fe9e..9988d41 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -12,6 +12,10 @@ - [Filesystem](development/design/filesystem.md) - [Configuring a Build Environment](development/environment.md) - [Development Workflow](development/workflow.md) +- [Debugging](debugging/README.md) + - [GDB]() + - [Logging]() + - [Performance Profiling]() # User Guide - [Using the OS](user/README.md) diff --git a/src/debugging/README.md b/src/debugging/README.md new file mode 100644 index 0000000..be1589e --- /dev/null +++ b/src/debugging/README.md @@ -0,0 +1,7 @@ +# Debugging + +Debugging code and understanding what's going wrong is highly important, especially in a complex setup such as this. +We will try to make it as easy as possible, with tools such as [tracing](https://lib.rs/crates/tracing). + +There are several external tools that can be used as well. + diff --git a/src/debugging/gdb.md b/src/debugging/gdb.md new file mode 100644 index 0000000..aef1f5f --- /dev/null +++ b/src/debugging/gdb.md @@ -0,0 +1 @@ +# GDB