Scarfski/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy.git synced 2026-06-08 08:33:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Hackfix section names in markdown manual.

Browse Source
This commit is contained in:
Bartosz Taudul
2025-07-12 12:23:48 +02:00
parent 31815fd45d
commit 6058e6ede0
2 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
manual/latex2md.sh
View File

@@ -8,5 +8,14 @@ sed -i -e 's@\\shift@Shift@g' _tmp.tex
sed -i -e 's@\\Alt@Alt@g' _tmp.tex
sed -i -e 's@\\del@Delete@g' _tmp.tex
sed -i -e 's@\\nameref{quicklook}@A quick look at Tracy Profiler@g' _tmp.tex
sed -i -e 's@\\nameref{firststeps}@First steps@g' _tmp.tex
sed -i -e 's@\\nameref{client}@Client markup@g' _tmp.tex
sed -i -e 's@\\nameref{capturing}@Capturing the data@g' _tmp.tex
sed -i -e 's@\\nameref{analyzingdata}@Analyzing captured data@g' _tmp.tex
sed -i -e 's@\\nameref{csvexport}@Exporting zone statistics to CSV@g' _tmp.tex
sed -i -e 's@\\nameref{importingdata}@Importing external profiling data@g' _tmp.tex
sed -i -e 's@\\nameref{configurationfiles}@Configuration files@g' _tmp.tex
pandoc --wrap=none --reference-location=block --number-sections -L filter.lua -s _tmp.tex -o tracy.md
rm -f _tmp.tex

16
manual/tracy.md
View File

@@ -19,21 +19,21 @@ The user manual
Hello and welcome to the Tracy Profiler user manual! Here you will find all the information you need to start using the profiler. This manual has the following layout:
- Chapter [1](#quicklook), , gives a short description of what Tracy is and how it works.
- Chapter [1](#quicklook), *A quick look at Tracy Profiler*, gives a short description of what Tracy is and how it works.
- Chapter [2](#firststeps), , shows how you can integrate the profiler into your application and how to build the graphical user interface (section [2.3](#buildingserver)). At this point, you will be able to establish a connection from the profiler to your application.
- Chapter [2](#firststeps), *First steps*, shows how you can integrate the profiler into your application and how to build the graphical user interface (section [2.3](#buildingserver)). At this point, you will be able to establish a connection from the profiler to your application.
- Chapter [3](#client), , provides information on how to instrument your application, in order to retrieve useful profiling data. This includes a description of the C API (section [3.13](#capi)), which enables usage of Tracy in any programming language.
- Chapter [3](#client), *Client markup*, provides information on how to instrument your application, in order to retrieve useful profiling data. This includes a description of the C API (section [3.13](#capi)), which enables usage of Tracy in any programming language.
- Chapter [4](#capturing), , goes into more detail on how the profiling information can be captured and stored on disk.
- Chapter [4](#capturing), *Capturing the data*, goes into more detail on how the profiling information can be captured and stored on disk.
- Chapter [5](#analyzingdata), , guides you through the graphical user interface of the profiler.
- Chapter [5](#analyzingdata), *Analyzing captured data*, guides you through the graphical user interface of the profiler.
- Chapter [6](#csvexport), , explains how to export some zone timing statistics into a CSV format.
- Chapter [6](#csvexport), *Exporting zone statistics to CSV*, explains how to export some zone timing statistics into a CSV format.
- Chapter [7](#importingdata), , documents how to import data from other profilers.
- Chapter [7](#importingdata), *Importing external profiling data*, documents how to import data from other profilers.
- Chapter [8](#configurationfiles), , gives information on the profiler settings.
- Chapter [8](#configurationfiles), *Configuration files*, gives information on the profiler settings.
# Quick-start guide {#quick-start-guide .unnumbered}