Skip to content

Commit

Permalink
improve: hide developer facing option --bpf-log from the help message
Browse files Browse the repository at this point in the history
End users without knowledges of einat internals should not use this.
  • Loading branch information
EHfive committed Jan 12, 2025
1 parent ff472ca commit 74f3148
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 3 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ OPTIONS:
--ports <range> ... External TCP/UDP port ranges, defaults to 20000-29999
--hairpin-if <name> ... Hairpin internal network interface names, e.g. lo, lan0
--internal <CIDR> ... Perform source NAT for these internal networks only
--bpf-log <level> BPF tracing log level, 0 to 5, defaults to 0, disabled
--bpf-loader <loader> BPF loading backend used, one of aya or libbpf
-v, --version Print einat version
```
Expand Down
3 changes: 2 additions & 1 deletion config.sample.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ nat44 = false
# Enable NAPT66, this requires that einat was built with "ipv6" feature flag.
nat66 = false

# Set max BPF log level
# Set max BPF log level, developer facing debugging option,
# would increases eBPF verification time if enabled.
# 0: disable, 1: error, 2: warn, 3: info, 4: debug, 5: trace
# View logs with `cat /sys/kernel/debug/tracing/trace_pipe`
bpf_log_level = 0
Expand Down
1 change: 0 additions & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ OPTIONS:
--ports <range> ... External TCP/UDP port ranges, defaults to 20000-29999
--hairpin-if <name> ... Hairpin internal network interface names, e.g. lo, lan0
--internal <CIDR> ... Perform source NAT for these internal networks only
--bpf-log <level> BPF tracing log level, 0 to 5, defaults to 0, disabled
--bpf-loader <loader> BPF loading backend used, one of aya or libbpf
-v, --version Print einat version
";
Expand Down

0 comments on commit 74f3148

Please sign in to comment.