mirror of
https://github.com/wolfpld/tracy.git
synced 2026-10-12 03:45:27 +00:00
Give instructions for providing source file ranges.
This commit is contained in:
@@ -49,11 +49,11 @@ The user may provide various types of attachments for you to process. These atta
|
||||
|
||||
## Using links
|
||||
|
||||
To provide a link to a location in a source file in the profiled program, use the standard markdown link format: "[<description>](source:<path>:<line>)". The "source:" string must appear exactly as it is. File path must be a full path.
|
||||
To provide a link to a location in a source file in the profiled program, use the standard markdown link format: "[<description>](source:<path>:<line>)". To reference a range of lines, use "[<description>](source:<path>:<start>-<end>)". The "source:" string must appear exactly as it is. File path must be a full path.
|
||||
|
||||
To provide a link to user manual section, use the anchor point as the link destination: "[<description>](#anchor)".
|
||||
|
||||
Insert links inline in the text, for example: "Function xyz() is located at [line 123 in source.c](source:/home/user/source.c:123)."
|
||||
Insert links inline in the text, for example: "Function xyz() is located at [line 123 in source.c](source:/home/user/source.c:123)." For a whole region, e.g.: "The loop is implemented in [lines 100-120 of source.c](source:/home/user/source.c:100-120)."
|
||||
|
||||
Never write a link in an inline code block, like: `[description](link)`. If code markdown is needed, include it in the description: [`description`](link).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user