From 92fc5822a8301d0c20d292e97d1661b25f5035bc Mon Sep 17 00:00:00 2001 From: Ed Maste Date: Tue, 7 Jun 2022 10:20:39 -0400 Subject: [PATCH] Clarify WITHOUT_KERNEL_SYMBOLS description Debug data is enabled via `makeoptions DEBUG=-g` in the kernel config file (e.g. GENERIC). If debug data is enabled and WITHOUT_KERNEL_SYMBOLS is set then debug data is included in the kernel and module files. PR: 264433 Discussed with: markj MFC after: 1 week Sponsored by: The FreeBSD Foundation --- share/man/man5/src.conf.5 | 6 ++++-- tools/build/options/WITHOUT_KERNEL_SYMBOLS | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5 index 084e42af4f7b..34e66c96d115 100644 --- a/share/man/man5/src.conf.5 +++ b/share/man/man5/src.conf.5 @@ -1,6 +1,6 @@ .\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman. .\" $FreeBSD$ -.Dd May 30, 2022 +.Dd June 7, 2022 .Dt SRC.CONF 5 .Os .Sh NAME @@ -833,7 +833,9 @@ and Enable the "retpoline" mitigation for CVE-2017-5715 in the kernel build. .It Va WITHOUT_KERNEL_SYMBOLS -Do not install kernel debug symbol files. +Do not build or install standalone kernel debug symbol files. +Debug data (if enabled by the kernel configuration file) +will be included in the kernel and modules. .It Va WITHOUT_KVM Do not build the .Nm libkvm diff --git a/tools/build/options/WITHOUT_KERNEL_SYMBOLS b/tools/build/options/WITHOUT_KERNEL_SYMBOLS index 33fa2c4f1c97..7837744cf399 100644 --- a/tools/build/options/WITHOUT_KERNEL_SYMBOLS +++ b/tools/build/options/WITHOUT_KERNEL_SYMBOLS @@ -1,2 +1,4 @@ .\" $FreeBSD$ -Do not install kernel debug symbol files. +Do not build or install standalone kernel debug symbol files. +Debug data (if enabled by the kernel configuration file) +will be included in the kernel and modules.