mirror/libbpf
1
0
Fork 0
mirror of https://github.com/netdata/libbpf.git synced 2026-04-05 08:09:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix up README's markdown formatting

Browse Source 
After making Github recognize README.md as markdown text,
there are a bunch of formatting problems. They are fixed in this commit.

Singed-off-by: Andrii Nakryiko <andriin@fb.com>
This commit is contained in:
Andrii Nakryiko
2019-05-15 20:55:16 -07:00
committed by Andrii Nakryiko
parent 58d39f2af3
commit 3a41dddce2
1 changed files with 41 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@@ -1,20 +1,19 @@
This is a mirror of bpf-next linux tree This is a mirror of [bpf-next linux tree](https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next)'s
(https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next) `tools/lib/bpf` directory plus its supporting header files.
bpf-next/tools/lib/bpf directory plus its supporting header files.
The following files will by sync'ed with bpf-next repo: The following files will by sync'ed with bpf-next repo:
src/ <-> bpf-next/tools/lib/bpf/ - `src/` <-> `bpf-next/tools/lib/bpf/`
include/uapi/linux/bpf_common.h <-> bpf-next/tools/include/uapi/linux/bpf_common.h - `include/uapi/linux/bpf_common.h` <-> `bpf-next/tools/include/uapi/linux/bpf_common.h`
include/uapi/linux/bpf.h <-> bpf-next/tools/include/uapi/linux/bpf.h - `include/uapi/linux/bpf.h` <-> `bpf-next/tools/include/uapi/linux/bpf.h`
include/uapi/linux/btf.h <-> bpf-next/tools/include/uapi/linux/btf.h - `include/uapi/linux/btf.h` <-> `bpf-next/tools/include/uapi/linux/btf.h`
include/uapi/linux/if_link.h <-> bpf-next/tools/include/uapi/linux/if_link.h - `include/uapi/linux/if_link.h` <-> `bpf-next/tools/include/uapi/linux/if_link.h`
include/uapi/linux/if_xdp.h <-> bpf-next/tools/include/uapi/linux/if_xdp.h - `include/uapi/linux/if_xdp.h` <-> `bpf-next/tools/include/uapi/linux/if_xdp.h`
include/uapi/linux/netlink.h <-> bpf-next/tools/include/uapi/linux/netlink.h - `include/uapi/linux/netlink.h` <-> `bpf-next/tools/include/uapi/linux/netlink.h`
include/tools/libc_compat.h <-> bpf-next/tools/include/tools/libc_compat.h - `include/tools/libc_compat.h` <-> `bpf-next/tools/include/tools/libc_compat.h`
Other header files at this repo (include/linux/*.h) are reduced versions of Other header files at this repo (`include/linux/*.h`) are reduced versions of
their counterpart files at bpf-next/tools/include/linux/*.h to make compilation their counterpart files at bpf-next's `tools/include/linux/*.h` to make compilation
successful. successful.
Build [![Build Status](https://travis-ci.org/libbpf/libbpf.svg?branch=master)](https://travis-ci.org/libbpf/libbpf) Build [![Build Status](https://travis-ci.org/libbpf/libbpf.svg?branch=master)](https://travis-ci.org/libbpf/libbpf)
@@ -22,42 +21,50 @@ Build [![Build Status](https://travis-ci.org/libbpf/libbpf.svg?branch=master)](h
libelf is an internal dependency of libbpf and thus it is required to link libelf is an internal dependency of libbpf and thus it is required to link
against and must be installed on the system for applications to work. against and must be installed on the system for applications to work.
pkg-config is used by default to find libelf, and the program called can be pkg-config is used by default to find libelf, and the program called can be
overridden with PKG_CONFIG. overridden with `PKG_CONFIG`.
If using pkg-config at build time is not desired, it can be disabled by setting If using `pkg-config` at build time is not desired, it can be disabled by setting
NO_PKG_CONFIG=1 when calling make. `NO_PKG_CONFIG=1` when calling make.
To build both static libbpf.a and shared libbpf.so: To build both static libbpf.a and shared libbpf.so:
cd src ```bash
make $ cd src
$ make
```
To build only static libbpf.a library in directory To build only static libbpf.a library in directory
build/ and install them together with libbpf headers in a staging directory build/ and install them together with libbpf headers in a staging directory
root/: root/:
cd src ```bash
mkdir build root $ cd src
BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install $ mkdir build root
$ BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install
```
To build both static libbpf.a and shared libbpf.so against a custom libelf To build both static libbpf.a and shared libbpf.so against a custom libelf
dependency installed in /build/root/ and install them together with libbpf dependency installed in /build/root/ and install them together with libbpf
headers in a build directory /build/root/: headers in a build directory /build/root/:
```bash
cd src $ cd src
PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make install $ PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make install
```
To integrate libbpf into a project which uses Meson building system define To integrate libbpf into a project which uses Meson building system define
[wrap-git] file in `subprojects` folder. `[wrap-git]` file in `subprojects` folder.
To add libbpf dependency to the parent parent project, e.g. for To add libbpf dependency to the parent parent project, e.g. for
libbpf_static_dep: libbpf_static_dep:
```
libbpf_obj = subproject('libbpf', required : true) libbpf_obj = subproject('libbpf', required : true)
libbpf_static_dep = libbpf_proj.get_variable('libbpf_static_dep') libbpf_static_dep = libbpf_proj.get_variable('libbpf_static_dep')
```
To validate changes to meson.build To validate changes to meson.build
```bash
python3 meson.py build $ python3 meson.py build
ninja -C build/ $ ninja -C build/
```
To install headers, libs and pkgconfig To install headers, libs and pkgconfig
cd build ```bash
ninja install $ cd build
$ ninja install
```