From 33d3a8cc61efb2d01565f41afdd7240a120f189f Mon Sep 17 00:00:00 2001 From: Roberto Santalla Date: Tue, 7 Jul 2020 11:53:27 +0200 Subject: [PATCH] doc: fix documentation error in usage section The example provided in the documentation used a different name for g_pFuncTableInfo, whic caused compilation to fail in GPAIL_LoadApi due to an undefined symbol: /tmp/ccuhxdcO.o: In function `GPAIL_LoadApi(GPA_API_Type, char const*)': main.cpp:(.text+0x502): undefined reference to `g_pFuncTableInfo' The documentation now includes the proper snippet taken from `include/gpu_perf_api_interface_loader.h` --- docs/sphinx/source/usage.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/usage.rst b/docs/sphinx/source/usage.rst index c90727fa..a61888b8 100644 --- a/docs/sphinx/source/usage.rst +++ b/docs/sphinx/source/usage.rst @@ -65,9 +65,10 @@ initialize the DirectX 12 version of GPA: #include "GPAInterfaceLoader.h" + #ifdef __cplusplus GPAApiManager* GPAApiManager::m_pGpaApiManager = nullptr; - - GPAFunctionTable* pGpaFunctionTable = nullptr; + #endif + GPAFuncTableInfo* g_pFuncTableInfo = NULL; bool InitializeGPA() {