improve debugging with ego-gdb

CMakeLists.txt

@@ -4,7 +4,10 @@ project(ego VERSION 1.5.0)
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE Debug)
 endif()
-if(NOT CMAKE_BUILD_TYPE STREQUAL Debug)
+if(CMAKE_BUILD_TYPE STREQUAL Debug)
+  # disable optimizations to improve debugging with gdb
+  set(PREMAIN_DEBUG_FLAGS -gcflags=all='-N -l')
+else()
   set(TRIMPATH -trimpath)
 endif()
 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
@@ -39,7 +42,7 @@ target_link_libraries(ego-enclave-lib PRIVATE openenclave::oe_includes)
 add_custom_command(
   OUTPUT premain.a
   DEPENDS ego/premain/main.go ego/premain/core/core.go
-  COMMAND ertgo build -buildmode=c-archive -o ${CMAKE_BINARY_DIR} ${TRIMPATH}
+  COMMAND ertgo build -buildmode=c-archive -o ${CMAKE_BINARY_DIR} ${TRIMPATH} ${PREMAIN_DEBUG_FLAGS}
   WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/ego/premain)
 add_custom_target(premainbuild DEPENDS premain.a)
 

docs/docs/workflows/debug.md

@@ -8,7 +8,10 @@ An EGo executable can be run as a normal host process without an enclave. Thus,
 
 ## Inside an enclave
 
-EGo comes with `ego-gdb` that augments `gdb` with enclave support. The `console` interface is the same as `gdb`:
+EGo comes with `ego-gdb` that augments `gdb` with enclave support.
+For a better debugging experience with it, compile your app without optimizations by passing `-gcflags=all="-N -l"` to `ego-go build`.
+
+The `console` interface of `ego-gdb` is the same as `gdb`:
 
 ```bash
 ego-gdb --args ./helloworld