path: root/src/extra/ipv4.c
diff options
authorDuncan Roe <>2019-11-18 14:36:37 +1100
committerPablo Neira Ayuso <>2019-12-07 18:54:07 +0100
commitbf519367fb335793f2ca63a1ef765ca398602d45 (patch)
tree666ff8d19724f0ded10f111d958747e1f7ddde45 /src/extra/ipv4.c
parent12c57417585e9ddafd52135cb770823cdb8d44a1 (diff)
src: doc: Major re-work of user packet buffer documentation
Divide functions into a hierarchy: top-level: Functions all programs that modify data will use 2nd-level: Rarely-used functions 3rd-level: Functions not to use (should have been declared static) Only the top-level functions appear on the "User-space network packet buffer" page, which looks a lot less daunting than it used to. Parameter descriptions all match prototypes All non-void functions have a "Returns" paragraph Code change: pktb_alloc: set errno to EPROTONOSUPPORT before doing error return because protocol is not supported Detailed other updates (top-level) pktb_alloc: - Add "Errors" para - Add "See also" para pktb_data, pktb_len: Add "appropriate use" line pktb_mangle: Add warning to use a different function unless mangling MAC hddr pktb_mangled: Add usage hint line Detailed other updates (2nd-level) pktb_mac_header: Point out only for AF_BRIDGE pktb_tailroom: Point out no dynamic expansion pktb_transport_header: Add note that programmer must code to set this Signed-off-by: Duncan Roe <> Signed-off-by: Pablo Neira Ayuso <>
Diffstat (limited to 'src/extra/ipv4.c')
0 files changed, 0 insertions, 0 deletions