Skip to content

Commit d603fa0

Browse files
committed
docs(readme): Adjust the headers and their levels
* Make the main `BPF Linker` the only H1 header. * Keep all the other sections as H2. * Adjust the levers of subsections to match the new layout. * Avoid duplicating the `Usage` title, name the latter section `CLI syntax`.
1 parent 3613cb4 commit d603fa0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ cargo install bpf-linker --no-default-features
4444

4545
If you don't have cargo you can get it from https://rustup.rs or from your distro's package manager.
4646

47-
# Usage
47+
## Usage
4848

49-
## Rust
49+
### Rust
5050

51-
### Nightly
51+
#### Nightly
5252

5353
To compile your eBPF crate just run:
5454

@@ -67,7 +67,7 @@ target = "bpfel-unknown-none"
6767
build-std = ["core"]
6868
```
6969

70-
#### (Experimental) BTF support
70+
##### (Experimental) BTF support
7171

7272
To emit [BTF debug information](https://www.kernel.org/doc/html/next/bpf/btf.html),
7373
set the following rustflags:
@@ -101,7 +101,7 @@ build-std = ["core"]
101101
After that, the BPF object file present in `target/bpfel-unknown-none/release`
102102
should contain a BTF section.
103103

104-
## Clang
104+
### Clang
105105

106106
For a simple example of how to use the linker with clang see [this
107107
gist](https://gist.github.com/alessandrod/ed6f11ba41bcd8a19d8655e57a00350b). In
@@ -113,7 +113,7 @@ The
113113
[Makefile](https://gist.github.com/alessandrod/ed6f11ba41bcd8a19d8655e57a00350b#file-makefile)
114114
shows how to compile the C code and then link it.
115115

116-
# Usage
116+
### CLI syntax
117117

118118
```
119119
bpf-linker

0 commit comments

Comments
 (0)