[PR #246] docs: clarify kernel headers requirement #261

New issue

Open

opened 2026-10-13 21:08:05 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-13 21:08:05 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/amnezia-vpn/amneziawg-linux-kernel-module/pull/246
Author: @HeisLuka
Created: 9/14/2026
Status: 🔄 Open

Base: master ← Head: docs/clarify-kernel-headers

📝 Commits (1)

1b9d266 docs: clarify kernel headers requirement

📊 Changes

1 file changed (+5 additions, -8 deletions)

View changed files

📝 README.md (+5 -8)

📄 Description

Summary

Update the manual build instructions to reflect the current build system.

The README currently says that kernels 5.6+ require a full kernel source tree
linked as src/kernel. The current Makefile instead builds against
/lib/modules/$(KERNELRELEASE)/build by default, and modern distributions can
build the module using their matching kernel headers package alone.

This change:

removes the unconditional full-kernel-source requirement;
documents the normal headers-based build path;
keeps KERNELDIR as the fallback for custom, legacy, or incomplete kernel
build environments.

No build or runtime behavior is changed.

Fixes #147

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/amnezia-vpn/amneziawg-linux-kernel-module/pull/246 **Author:** [@HeisLuka](https://github.com/HeisLuka) **Created:** 9/14/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `docs/clarify-kernel-headers` --- ### 📝 Commits (1) - [`1b9d266`](https://github.com/amnezia-vpn/amneziawg-linux-kernel-module/commit/1b9d2660c73d6ea1431d1a521d3105389e0297c4) docs: clarify kernel headers requirement ### 📊 Changes **1 file changed** (+5 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+5 -8) </details> ### 📄 Description ## Summary Update the manual build instructions to reflect the current build system. The README currently says that kernels 5.6+ require a full kernel source tree linked as `src/kernel`. The current Makefile instead builds against `/lib/modules/$(KERNELRELEASE)/build` by default, and modern distributions can build the module using their matching kernel headers package alone. This change: - removes the unconditional full-kernel-source requirement; - documents the normal headers-based build path; - keeps `KERNELDIR` as the fallback for custom, legacy, or incomplete kernel build environments. No build or runtime behavior is changed. Fixes #147 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-13 21:08:05 +00:00

No labels

pull-request

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

amnezia-vpn/amneziawg-linux-kernel-module#261

No description provided.

Rows
Columns