From 0809778b267dcd7e53078f865c5359ce79601f3b Mon Sep 17 00:00:00 2001 From: baldurk Date: Mon, 12 Sep 2016 15:09:25 +0200 Subject: [PATCH] Add a FAQ entry about hooking child processes --- docs/getting_started/faq.rst | 9 +++++++++ docs/window/capture_log_attach.rst | 2 ++ 2 files changed, 11 insertions(+) diff --git a/docs/getting_started/faq.rst b/docs/getting_started/faq.rst index 10cb74596..476791785 100644 --- a/docs/getting_started/faq.rst +++ b/docs/getting_started/faq.rst @@ -213,3 +213,12 @@ The path you specify (with the stripped shader, or at runtime) can be either abs The stripped shader file stored on disk can also be compressed with LZ4 to save space as often most of the size is made up for shader source text which compresses well. To do this, simply compress the contents of the file and prepend the pathname (either absolute or relative, specified in the shader blob or at runtime) with ``lz4#``. For example code using this method, check out :doc:`tips_tricks`. + +I want to debug a process that my program launches itself, how can I inject RenderDoc? +-------------------------------------------------------------------------------------- + +When launching a process in RenderDoc, by default only this process is debugged and any children it launches are not affected. This better ensures compatibility for the most common case where you are able to start the process to be debugged directly. + +In the case where your program launches sub-processes that you would like to debug, you can enable the ``Hook into Children`` capture option, which causes RenderDoc to recursively inject itself into all children (and grand-children, and so on). When you open a capture connection, the child processes will be displayed and you can open a connection to each child to locate the process you wish to debug. + +There are :ref:`more details available ` in the documentation for the :doc:`../window/capture_log_attach` window. diff --git a/docs/window/capture_log_attach.rst b/docs/window/capture_log_attach.rst index f172a8040..56315c1e1 100644 --- a/docs/window/capture_log_attach.rst +++ b/docs/window/capture_log_attach.rst @@ -154,6 +154,8 @@ This option is slightly different from the others in that it doesn't change anyt This option allows you to queue up a precise capture of a given frame number after the program has started. +.. _child-process-hook: + Child Processes ---------------