mirror of
https://github.com/lgcosta/pf-linux-port.git
synced 2026-11-13 02:28:03 -03:00
lgcosta
dff2185b20
- Demo docs replaced by the screencast docs (single source of truth): the legacy demo-session.sh/demo-record.py and the v0.9 renderer were removed instead of being kept as a second convention. - feature-matrix: stale 'M2-in-progress' vocabulary gone; the rows the 15 gates prove now say VERIFIED-in-VM and name the gate; af-to is now an explicit non-goal row (INET6 0 in this build). - guide: the queues/divert/pflog sections described a state that no longer exists (priq-only, divert dropping packets, pflog logging nothing); they now describe the shipped behaviour. - vm-lab: the 15 real gates with what each proves, 15/15 green, and the pf0 -> cli/srv/gw2 ssh setup the screencasts rely on. - install/build: pdivert and pflogd are built and ported (docs said otherwise); module object list now includes hfsc.c, fq_codel.c, pfk_pflog.c; the screencast pipeline is an optional build stage. - pf-guide: the 'M2 scope only' framing is gone; honest gaps listed. - caveats: three new sections about the screencast pipeline (MiniMax video generation blocked by the account tier, narration as a separate track, a video frame is not a verdict). - porting-notes: what the recording taught us. - README/README.pt-BR: status, milestones, layout and video section updated. All internal doc links verified.
43 lines
2.5 KiB
Markdown
43 lines
2.5 KiB
Markdown
# Documentação do PF-on-Linux (português)
|
||
|
||
English documentation: [`docs/en/README.md`](../en/README.md).
|
||
|
||
Este é o conjunto de documentação de usuário do port do **packet filter do
|
||
OpenBSD 8.0 (PF)** para o **Linux 7.3.4** — o engine PF real (`pf.c`,
|
||
`pf_norm.c`, `pf_table.c`, `pf_lb.c`, `hfsc.c`, …) rodando como o módulo
|
||
out-of-tree `pf.ko`, controlado pelo `pfctl` real do OpenBSD sobre a ABI ioctl
|
||
de `/dev/pf`.
|
||
|
||
## Índice
|
||
|
||
| Doc | O que cobre |
|
||
|---|---|
|
||
| [guide.md](guide.md) | Arquitetura em uma página: componentes, caminho de dados, plano de controle, milestones |
|
||
| [install.md](install.md) | Receita de apply/build/install (kernel, módulo, ferramentas) |
|
||
| [build.md](build.md) | Pipeline de build em detalhe: fetch → vendorize → kernel → módulo → pfctl |
|
||
| [vm-lab.md](vm-lab.md) | O lab de validação em libvirt: topologia, recriar/rodar, o que cada um dos 15 gates prova |
|
||
| [feature-matrix.md](feature-matrix.md) | Status por feature: VERIFIED-in-VM / VERIFIED-offline / COMPILES-untested / NOT-ENABLED |
|
||
| [pf-guide.md](pf-guide.md) | Uso diário: o que funciona hoje em `/etc/pf.conf` e as divergências a conhecer |
|
||
| [screencast.md](screencast.md) | Os vídeos narrados (inglês e português): fases, pipeline, como regravar |
|
||
| [patches.md](patches.md) | Conjunto de patches de core do Linux (hoje vazio) + regras e template para futuros `000N-*.patch` |
|
||
| [caveats.md](caveats.md) | Divergências conhecidas em relação ao OpenBSD e limitações atuais |
|
||
|
||
## Fontes da verdade
|
||
|
||
Os docs descrevem o código como ele existe nesta árvore. Na dúvida, as
|
||
referências autoritativas são:
|
||
|
||
- `docs/superpowers/specs/2026-11-11-pf-linux-port-design.md` — design
|
||
- `docs/superpowers/plans/2026-11-11-pf-linux-port.md` — plano dos milestones (tarefas T1–T19)
|
||
- `docs/porting-notes.md` — log de staging + registro das divergências (a verdade sobre as divergências da camada de compat)
|
||
|
||
Vocabulário de status usado nestes docs:
|
||
|
||
- **VERIFIED-in-VM** — exercitado de ponta a ponta no lab libvirt; o gate que prova está nomeado (veja [vm-lab.md](vm-lab.md)).
|
||
- **VERIFIED-offline** — provado por um teste de fixture ou de ABI, não por tráfego.
|
||
- **COMPILES-untested** — o código é compilado dentro do `pf.ko`/`pfctl` mas nenhum gate o exercitou.
|
||
- **NOT-ENABLED** — o código existe mas a feature está desligada neste build.
|
||
- **OUT-OF-SCOPE** — fora de escopo por desenho (spec §3).
|
||
|
||
A suíte do lab está **15/15 verde** (`./scripts/vm-run-tests.sh`).
|