Documentation | Draft: Add section "Debugging" to RTEMS documentation (!43)

[Suraj Kumar (@the.m3chanic)]

Suraj  Kumar commented on a discussion on user/debugging/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/43#note_111226

 > +
 > +Debugging
 > +***********
 > +.. index:: Debugging
 > +.. index:: Embedded executable
 > +
 > +Debugging is a critical process in software development that involves
 > +identifying and resolving bugs or defects in a program. A debugger is a tool
 > +that allows developers to inspect the internal state of a program while it runs
 > +or after it crashes (like with a core dump), providing insights into the
 > +program's execution flow and state.
 > +
 > +A debugger allows us to:
 > +
 > +#. Set breakpoints to pause execution at specific points
 > +

If you are referring to lines 11 and 17 here, then yes. When I built without those newlines they rendered something like this: 

```
A debugger allows us to: #. Set breakpoints to pause execution at specific points
```

Turns out ReST needs a newline in most places in order to have formatting take effect. 

And nope, when I rendered they all load well, you can take a look here from my local build: 

![image.png](/uploads/5e4b004e7c9b7fe14f09a303a01dd9b8/image.png){width=747 height=395}

I hope that clarifies things

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/43#note_111226
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20240818/b8db4f8a/attachment-0001.htm>