Skip to content

Commit 21f5dad

Browse files
committed
[NFC][docs][coro] Fix syntax & typos
Follow-up fixes to #142651
1 parent 7138397 commit 21f5dad

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

clang/docs/DebuggingCoroutines.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ still improving their support for coroutines. As such, we recommend using the
2424
latest available version of your toolchain.
2525

2626
This document focuses on clang and lldb. The screenshots show
27-
[lldb-dap](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap)
27+
`lldb-dap <https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap>`_
2828
in combination with VS Code. The same techniques can also be used in other
2929
IDEs.
3030

@@ -913,7 +913,7 @@ Note that this script requires LLDB 21.0 or newer.
913913
continuation_paths = continuation_paths)
914914
915915
916-
class Coroin-flightCommand(ParsedCommand):
916+
class CoroInflightCommand(ParsedCommand):
917917
def get_short_help(self):
918918
return "Identify all in-flight coroutines"
919919
@@ -993,7 +993,7 @@ Note that this script requires LLDB 21.0 or newer.
993993
def __lldb_init_module(debugger, internal_dict):
994994
debugger.HandleCommand("command container add -h 'Debugging utilities for C++20 coroutines' coro")
995995
debugger.HandleCommand(f"command script add -o -p -c {__name__}.CoroBacktraceCommand coro bt")
996-
debugger.HandleCommand(f"command script add -o -p -c {__name__}.Coroin-flightCommand coro in-flight")
996+
debugger.HandleCommand(f"command script add -o -p -c {__name__}.CoroInflightCommand coro in-flight")
997997
print("Coro debugging utilities installed. Use `help coro` to see available commands.")
998998
999999
if __name__ == '__main__':
@@ -1012,7 +1012,7 @@ For GDB, the following script provides a couple of useful commands:
10121012

10131013
.. code-block:: python
10141014
1015-
# debugging-helper.py
1015+
# debugging-helper.py
10161016
import gdb
10171017
from gdb.FrameDecorator import FrameDecorator
10181018
@@ -1160,11 +1160,11 @@ Further Reading
11601160

11611161
The authors of the Folly libraries wrote a blog post series on how they debug coroutines:
11621162

1163-
* [Async stack traces in folly: Introduction](https://developers.facebook.com/blog/post/2021/09/16/async-stack-traces-folly-Introduction/)
1164-
* [Async stack traces in folly: Synchronous and asynchronous stack traces](https://developers.facebook.com/blog/post/2021/09/23/async-stack-traces-folly-synchronous-asynchronous-stack-traces/)
1165-
* [Async stack traces in folly: Forming an async stack from individual frames](https://developers.facebook.com/blog/post/2021/09/30/async-stack-traces-folly-forming-async-stack-individual-frames/)
1166-
* [Async Stack Traces for C++ Coroutines in Folly: Walking the async stack](https://developers.facebook.com/blog/post/2021/10/14/async-stack-traces-c-plus-plus-coroutines-folly-walking-async-stack/)
1167-
* [Async stack traces in folly: Improving debugging in the developer lifecycle](https://developers.facebook.com/blog/post/2021/10/21/async-stack-traces-folly-improving-debugging-developer-lifecycle/)
1163+
* `Async stack traces in folly: Introduction <https://developers.facebook.com/blog/post/2021/09/16/async-stack-traces-folly-Introduction/>`_
1164+
* `Async stack traces in folly: Synchronous and asynchronous stack traces <https://developers.facebook.com/blog/post/2021/09/23/async-stack-traces-folly-synchronous-asynchronous-stack-traces/>`_
1165+
* `Async stack traces in folly: Forming an async stack from individual frames <https://developers.facebook.com/blog/post/2021/09/30/async-stack-traces-folly-forming-async-stack-individual-frames/>`_
1166+
* `Async Stack Traces for C++ Coroutines in Folly: Walking the async stack <https://developers.facebook.com/blog/post/2021/10/14/async-stack-traces-c-plus-plus-coroutines-folly-walking-async-stack/>`_
1167+
* `Async stack traces in folly: Improving debugging in the developer lifecycle <https://developers.facebook.com/blog/post/2021/10/21/async-stack-traces-folly-improving-debugging-developer-lifecycle/>`_
11681168

11691169
Besides some topics also covered here (stack traces from the debugger), Folly's blog post series also covers
11701170
more additional topics, such as capturing async strack traces in performance profiles via eBPF filters

0 commit comments

Comments
 (0)