sync: Add section about need for Makefile adjustments

When performing a sync with the kernel repository using the
sync-kernel.sh script, it may be necessary to manually adjust the
library's Makefile if:
- new source files were added upstream
- new public headers were added upstream

This change adds a new section to `SYNC.md` to spell out this need.

Signed-off-by: Daniel Müller <deso@posteo.net>
This commit is contained in:
Daniel Müller
2023-03-06 08:05:17 -08:00
committed by Andrii Nakryiko
parent a41e6ef325
commit cf46d44f0a

14
SYNC.md
View File

@@ -152,6 +152,20 @@ sure that each such commit has `Signed-off-by: Your Full Name <your@email.com>`,
just like you'd do that for Linux upstream patch. Libbpf closely follows kernel
conventions and styling, so please help maintaining that.
Including new sources
---------------------
If entirely new source files (typically `*.c`) were added to the library in the
kernel repository, it may be necessary to add these to the build system
manually (you may notice linker errors otherwise), because the script cannot
handle such changes automatically. To that end, edit `src/Makefile` as
necessary. Commit
[c2495832ced4](https://github.com/libbpf/libbpf/commit/c2495832ced4239bcd376b9954db38a6addd89ca)
is an example of how to go about doing that.
Similarly, if new public API header files were added, the `Makefile` will need
to be adjusted as well.
Updating allow/deny lists
-------------------------