Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .clang-tidy
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ CheckOptions:
value: true
# Allow specific masks
- key: readability-magic-numbers.IgnoredIntegerValues
value: 255;65535;100
value: 3;255;65535;100
2 changes: 2 additions & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ set(doc_srcs
${CMAKE_CURRENT_SOURCE_DIR}/developers/style.rst
${CMAKE_CURRENT_SOURCE_DIR}/developers/tests.rst
${CMAKE_CURRENT_SOURCE_DIR}/developers/modules/index.rst
${CMAKE_CURRENT_SOURCE_DIR}/developers/modules/core/index.rst
${CMAKE_CURRENT_SOURCE_DIR}/developers/modules/core/locking.rst
${CMAKE_CURRENT_SOURCE_DIR}/developers/modules/libbpfilter/libbpfilter.rst
${CMAKE_CURRENT_SOURCE_DIR}/external/benchmarks/index.rst
${CMAKE_CURRENT_SOURCE_DIR}/external/coverage/index.rst
Expand Down
2 changes: 1 addition & 1 deletion doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ PROJECT_NAME = "@PROJECT_NAME@"
PROJECT_BRIEF = An eBPF-based packet filtering framework
OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@"
STRIP_FROM_PATH = "@CMAKE_SOURCE_DIR@/src" "@CMAKE_SOURCE_DIR@/tests"
STRIP_FROM_INC_PATH = "@CMAKE_SOURCE_DIR@/src" "@CMAKE_SOURCE_DIR@/tests"
STRIP_FROM_INC_PATH = "@CMAKE_SOURCE_DIR@/src/libbpfilter/include" "@CMAKE_SOURCE_DIR@/tests"
OPTIMIZE_OUTPUT_FOR_C = YES
AUTOLINK_SUPPORT = YES
IDL_PROPERTY_SUPPORT = NO
Expand Down
10 changes: 10 additions & 0 deletions doc/developers/modules/core/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Core
====

Core building blocks of the project.

.. toctree::
:titlesonly:
:glob:

*
5 changes: 5 additions & 0 deletions doc/developers/modules/core/locking.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Locking
=======

.. doxygenfile:: core/lock.h
:sections: briefdescription detaileddescription innerclass public-type public-attrib typedef enum define var func
1 change: 1 addition & 0 deletions doc/developers/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Modules
:caption: Modules

libbpfilter/libbpfilter
core/index

``bpfilter`` is composed of multiple modules depending on each other. Splitting the project in different modules allows for the source code to be efficiently reused:

Expand Down
1 change: 1 addition & 0 deletions src/libbpfilter/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ set(libbpfilter_srcs
${CMAKE_CURRENT_SOURCE_DIR}/io.c
${CMAKE_CURRENT_SOURCE_DIR}/core/hashset.c
${CMAKE_CURRENT_SOURCE_DIR}/core/list.c
${CMAKE_CURRENT_SOURCE_DIR}/core/lock.h ${CMAKE_CURRENT_SOURCE_DIR}/core/lock.c
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude: nit: The .h and .c for core/lock are on the same line with wide whitespace padding. The rest of the file lists one path per line. Consider splitting onto separate lines (or listing only the .c, since private headers are not typically registered as sources here).

${CMAKE_CURRENT_SOURCE_DIR}/core/vector.c
${CMAKE_CURRENT_SOURCE_DIR}/logger.c
${CMAKE_CURRENT_SOURCE_DIR}/matcher.c
Expand Down
Loading
Loading