Skip to content

Commit 7360ab1

Browse files
[docs] fix debug.h placement in docs
1 parent 3e2a7b8 commit 7360ab1

File tree

4 files changed

+10
-28
lines changed

4 files changed

+10
-28
lines changed

docs/headers/ti/debug.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/headers/ti/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ whoever in the community first discovered something gave it a name following the
1515
:maxdepth: 1
1616
:glob:
1717

18-
debug
1918
error
2019
flags
2120
getcsc

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ If you are interested in contributing your expertise, check out the :ref:`contri
2626

2727
static/getting-started
2828
static/makefile-options
29+
static/debugging
2930
static/printf
3031
static/fileio
31-
static/ides
32-
static/debugging
3332
static/asm
3433

3534
.. toctree::
@@ -45,6 +44,7 @@ If you are interested in contributing your expertise, check out the :ref:`contri
4544
:caption: Helpful Resources
4645
:maxdepth: 1
4746

47+
static/ides
4848
static/git
4949
static/coding-guidelines
5050
static/contributing

docs/static/debugging.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The toolchain offers the ability to debug your programs using the `CEmu emulator
88
Add :code:`#include <debug.h>` to a source file, and use :code:`make debug` instead of :code:`make` to build a debug program.
99
You may need to run :code:`make clean` beforehand in order to ensure all source files are rebuilt.
1010

11-
Printing to the console
12-
-----------------------
11+
Emulator Console
12+
----------------
1313

1414
Printing is a classic debugging technique. :code:`dbg_printf()` allows you to print variables and strings to the CEmu console.
1515
It uses the `standard printf format specifiers <http://www.cplusplus.com/reference/cstdio/printf/>`_.
@@ -25,17 +25,20 @@ Here are some examples:
2525
dbg_printf("var value: %d\n", var);
2626
dbg_printf("PROGRAM ABORTED (code = %u)\n", code);
2727
28-
To view the output of these functions within `CEmu <https://ce-programming.github.io/CEmu>`_, enable the console using **Docks > Console**.
28+
29+
.. note::
30+
31+
To view the output of these functions within `CEmu <https://ce-programming.github.io/CEmu>`_, enable the console using **Docks > Console**.
2932

3033
debug.h
31-
=======
34+
-------
3235

3336
.. code-block:: c
3437
3538
#include <debug.h>
3639
3740
API Documentation
38-
-----------------
41+
+++++++++++++++++
3942

4043
.. doxygenfile:: debug.h
4144
:project: CE C/C++ Toolchain

0 commit comments

Comments
 (0)