Page MenuHomeFreeBSD
Differential D51805

share/mk: Deduplicate some handling of debug info
ClosedPublic
Actions

Authored by markj on Aug 7 2025, 8:27 PM.
Tags
None
Referenced Files
F142560813: D51805.diff
Wed, Jan 21, 12:34 AM
Unknown Object (File)
Sun, Jan 18, 11:20 PM
Unknown Object (File)
Tue, Dec 30, 5:25 PM
Unknown Object (File)
Tue, Dec 30, 4:43 PM
Unknown Object (File)
Tue, Dec 30, 4:15 PM
Unknown Object (File)
Dec 21 2025, 11:27 PM
Unknown Object (File)
Dec 14 2025, 8:08 PM
Unknown Object (File)
Dec 12 2025, 6:47 PM
View All 82 Files
Subscribers
bdrewery
imp

Details

Reviewers
emaste
sjg
brooks
bdrewery
Commits
rG8545586793f2: share/mk: Deduplicate some handling of debug info
rG3a239e46c4aa: share/mk: Deduplicate some handling of debug info
Summary

bsd.prog.mk and bsd.lib.mk contain a bunch of duplicated logic used to
handle DEBUG_FLAGS and standalone debug file info (enabled by
MK_DEBUG_FILES). In anticipation of adding more duplicated logic, let's
try factoring it out into a separate bsd.debug.mk first.

bsd.debug.mk now handles the following:

  • MK_ASSERT_DEBUG
  • installation rules for debug files (the consumer has to set DEBUGFILE)
  • updating CFLAGS and CXXFLAGS based on DEBUG_FLAGS
  • optionally stripping installed files

No functional change intended.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 66103
Build 62986: arc lint + arc unit

Event Timeline

markj created this revision.Aug 7 2025, 8:27 PM
Herald added subscribers: imp, bdrewery. · View Herald TranscriptAug 7 2025, 8:27 PM
markj requested review of this revision.Aug 7 2025, 8:27 PM
Harbormaster completed remote builds in B66073: Diff 159995.Aug 7 2025, 8:27 PM
markj mentioned this in D50951: share/mk: Substitute reproducible prefixes in dwarf info.Aug 7 2025, 8:29 PM
bdrewery accepted this revision.Aug 7 2025, 8:33 PM

Seems okay. Be sure to test a bsd.progs.mk user too.

This revision is now accepted and ready to land.Aug 7 2025, 8:33 PM
markj added a comment.Aug 8 2025, 1:12 PM

I tested this by doing a reproducible buildworld+installworld, with and without the patch. I ran diff -r to look for differences in the installed directories. The only ones are in /rescue binaries. This is due to a small behaviour changes here which I think is harmless: before, bsd.prog.mk would not add DEBUG_FLAGS to CFLAGS if CRUNCH_CFLAGS was set. (But bsd.lib.mk added it regardless.) So now bsd.prog.mk behaves like bsd.lib.mk, i.e., we don't do anything special for crunchgen binaries. That is, rescue files are built with -g and stripped, resulting in slightly different executables.

markj updated this revision to Diff 160052.Aug 8 2025, 1:23 PM
  • Add a top-level comment
  • Remove a guard whose purpose I'm not sure about
  • Remove an unneeded include
This revision now requires review to proceed.Aug 8 2025, 1:23 PM
Harbormaster completed remote builds in B66103: Diff 160052.Aug 8 2025, 1:23 PM
bdrewery added a comment.Aug 8 2025, 4:39 PM

It's fine to remove the guard but it's not a bad idea to have it there too.

Can you also add this file to bsd.README?

I don't recall what, if any, pattern we have for not-user-includable files. But worth mentioning something there still.

markj added a comment.Aug 8 2025, 5:58 PM
In D51805#1184000, @bdrewery wrote:

It's fine to remove the guard but it's not a bad idea to have it there too.

What exactly do the guards protect against?

Can you also add this file to bsd.README?

Will do.

I don't recall what, if any, pattern we have for not-user-includable files. But worth mentioning something there still.

I extended the comment a bit.

markj updated this revision to Diff 160079.Aug 8 2025, 5:58 PM
  • List the file in bsd.README
  • Note in the header comment that user makefiles shouldn't include this directly
Harbormaster completed remote builds in B66119: Diff 160079.Aug 8 2025, 5:58 PM
markj added a child revision: D50951: share/mk: Substitute reproducible prefixes in dwarf info.Aug 12 2025, 8:32 PM
markj added a comment.Aug 18 2025, 1:59 PM

I'll commit this in a few days if there are no objections.

emaste added a comment.Aug 18 2025, 6:00 PM

Looks OK, no objection.

This revision was not accepted when it landed; it landed in state Needs Review.Aug 21 2025, 3:58 PM
Closed by commit rG3a239e46c4aa: share/mk: Deduplicate some handling of debug info (authored by markj). · Explain Why
This revision was automatically updated to reflect the committed changes.
markj added a commit: rG3a239e46c4aa: share/mk: Deduplicate some handling of debug info.
markj added a commit: rG8545586793f2: share/mk: Deduplicate some handling of debug info.Sep 30 2025, 9:14 PM

Revision Contents
Changeset List

PathSize
share/
mk/
1 line
45 lines
52 lines
7 lines
55 lines

Diff 160052

View Options

share/mk/Makefile

Loading...
View Options

share/mk/bsd.debug.mk

Loading...
View Options

share/mk/bsd.lib.mk

Loading...
View Options

share/mk/bsd.own.mk

Loading...
View Options

share/mk/bsd.prog.mk

Loading...