Skip to content

Commit

Permalink
docs: update readme for attaching containers
Browse files Browse the repository at this point in the history
  • Loading branch information
Danyal-Faheem committed Nov 13, 2024
1 parent 899d9dc commit cf149e6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,17 @@ Finally, the platform can also be started back up with ``launch``. It will take
Debugging with breakpoints
--------------------------

To debug a local edx-platform repository, add a `python breakpoint <https://docs.python.org/3/library/functions.html#breakpoint>`__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name::
To debug a local edx-platform repository, add a `python breakpoint <https://docs.python.org/3/library/functions.html#breakpoint>`__ with ``breakpoint()`` anywhere in the code. Then, start the container by running ``start -d`` followed by the service's name and attach to the container by running ``attach`` followed by the service's name::

# Debugging LMS:
tutor dev start lms
tutor dev start -d lms
tutor dev attach lms

# Or, debugging CMS:
tutor dev start cms
tutor dev start -d cms
tutor dev attach cms

To detach from the container without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``.

Running arbitrary commands
--------------------------
Expand Down

0 comments on commit cf149e6

Please sign in to comment.