Skip to content

Drop SEC("license") explanation from README license section - #2

Merged
necco-c merged 1 commit into
mainfrom
readme-drop-license-detail
Aug 11, 2026
Merged

Drop SEC("license") explanation from README license section#2
necco-c merged 1 commit into
mainfrom
readme-drop-license-detail

Conversation

@necco-c

@necco-c necco-c commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

The License section now reads simply GPL-2.0.

What changed

One sentence removed from README.md. Nothing else in the repo is touched.

Why

The removed sentence explained the BPF program's ELF license declaration as README prose. Presented that way it reads like display text, which invited the reading that it could be reworded or deleted. It cannot: char LICENSE[] SEC("license") = "GPL" in agent/src/bpf/httptop.bpf.c is the token the kernel reads at program load to gate GPL-only helpers (bpf_probe_read_kernel, bpf_perf_event_output, and others httpwatch uses). Change or remove it and the program fails verification and httpwatch stops working.

The declaration itself is unchanged. This PR only removes the prose describing it.

Still open

There is no repo-level LICENSE file, so GPL-2.0 in the README remains a stated license that has not been verified for the vendored code under agent/. Removing the parenthetical does not close that gap, it just stops surfacing it on the page. The real fix is to trace the upstream provenance of the vendored program and add a real LICENSE file, or a NOTICE recording the source and that the license is unverified. Worth tracking separately.

Also note agent/README.md:253 still carries similar wording. Left untouched, since the request named the top-level README.

The License section now reads "GPL-2.0." with no further detail.

The removed sentence described the BPF program's ELF license section as
prose. It was a source of confusion: it reads like display text, but
char LICENSE[] SEC("license") = "GPL" is what the kernel checks at load
time to gate GPL-only helpers. The declaration itself is unchanged.
@necco-c
necco-c merged commit ac515fe into main Aug 11, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant