From 3a41dddce2a0c248b9102c84ed1a84e48abc4e11 Mon Sep 17 00:00:00 2001 From: Andrii Nakryiko Date: Wed, 15 May 2019 20:55:16 -0700 Subject: [PATCH] Fix up README's markdown formatting 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 --- README.md | 75 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 82effe2..09e5535 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ -This is a mirror of bpf-next linux tree -(https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next) -bpf-next/tools/lib/bpf directory plus its supporting header files. +This is a mirror of [bpf-next linux tree](https://kernel.googlesource.com/pub/scm/linux/kernel/git/bpf/bpf-next)'s +`tools/lib/bpf` directory plus its supporting header files. The following files will by sync'ed with bpf-next repo: - 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.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/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/netlink.h <-> bpf-next/tools/include/uapi/linux/netlink.h - include/tools/libc_compat.h <-> bpf-next/tools/include/tools/libc_compat.h + - `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.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/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/netlink.h` <-> `bpf-next/tools/include/uapi/linux/netlink.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 -their counterpart files at bpf-next/tools/include/linux/*.h to make compilation +Other header files at this repo (`include/linux/*.h`) are reduced versions of +their counterpart files at bpf-next's `tools/include/linux/*.h` to make compilation successful. 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 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 -overridden with PKG_CONFIG. -If using pkg-config at build time is not desired, it can be disabled by setting -NO_PKG_CONFIG=1 when calling make. +overridden with `PKG_CONFIG`. +If using `pkg-config` at build time is not desired, it can be disabled by setting +`NO_PKG_CONFIG=1` when calling make. To build both static libbpf.a and shared libbpf.so: - cd src - make +```bash +$ cd src +$ make +``` To build only static libbpf.a library in directory build/ and install them together with libbpf headers in a staging directory root/: - cd src - mkdir build root - BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install +```bash +$ cd src +$ 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 dependency installed in /build/root/ and install them together with libbpf headers in a build directory /build/root/: - - cd src - PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make install +```bash +$ cd src +$ PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make install +``` 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 libbpf_static_dep: - - libbpf_obj = subproject('libbpf', required : true) - libbpf_static_dep = libbpf_proj.get_variable('libbpf_static_dep') +``` +libbpf_obj = subproject('libbpf', required : true) +libbpf_static_dep = libbpf_proj.get_variable('libbpf_static_dep') +``` To validate changes to meson.build - - python3 meson.py build - ninja -C build/ +```bash +$ python3 meson.py build +$ ninja -C build/ +``` To install headers, libs and pkgconfig - cd build - ninja install - +```bash +$ cd build +$ ninja install +```