iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
linux/Documentation/networking
History
Jakub Kicinski 82e896d992 docs: net: page_pool: use kdoc to avoid duplicating the information 
All struct members of the driver-facing APIs are documented twice,
in the code and under Documentation. This is a bit tedious.

I also get the feeling that a lot of developers will read the header
when coding, rather than the doc. Bring the two a little closer
together by using kdoc for structs and functions.

Using kdoc also gives us links (mentioning a function or struct
in the text gets replaced by a link to its doc).

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>
Link: https://lore.kernel.org/r/20230802161821.3621985-3-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2023-08-03 09:54:24 -07:00
..
caif
tty: cumulate and document tty_struct::flow* members
2021-05-13 16:57:16 +02:00
device_drivers
docs: octeontx2: extend documentation for Round Robin scheduling
2023-07-21 09:55:54 +01:00
devlink
Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net
2023-04-20 16:29:51 -07:00
dsa
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
mac80211_hwsim
docs: net: convert two README files to ReST format
2019-07-31 13:31:56 -06:00
6lowpan.rst
docs: networking: convert 6lowpan.txt to ReST
2020-02-28 14:52:36 +01:00
6pack.rst
docs: networking: convert 6pack.txt to ReST
2020-04-28 14:38:38 -07:00
af_xdp.rst
xsk: add multi-buffer documentation
2023-07-19 09:56:50 -07:00
alias.rst
…
arcnet-hardware.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
arcnet.rst
Documentation: networking: arcnet: drop doubled word
2020-07-04 17:46:21 -07:00
atm.rst
docs: networking: convert atm.txt to ReST
2020-04-28 14:38:38 -07:00
ax25.rst
Documentation: networking: ax25: drop doubled word
2020-07-04 17:46:21 -07:00
bareudp.rst
Documentation: bareudp: Corrected description of bareudp module.
2020-07-28 17:53:03 -07:00
batman-adv.rst
batman-adv: Fix mailing list address
2023-01-21 19:01:59 +01:00
bonding.rst
Documentation: bonding: fix the doc of peer_notif_delay
2023-05-10 09:27:20 +01:00
bridge.rst
docs: networking: Fix bridge documentation URL
2023-01-25 22:44:27 -08:00
can_ucan_protocol.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
can.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
cdc_mbim.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
checksum-offloads.rst
docs: networking: convert netdev-features.txt to ReST
2020-04-30 12:56:36 -07:00
dccp.rst
net: dccp: Add SIOCOUTQ IOCTL support (send buffer fill)
2020-07-22 17:00:37 -07:00
dctcp.rst
docs: networking: convert dctcp.txt to ReST
2020-04-28 14:38:39 -07:00
dns_resolver.rst
docs: networking: convert dns_resolver.txt to ReST
2020-04-28 14:39:46 -07:00
driver.rst
net: docs: update the sample code in driver.rst
2023-04-13 13:30:21 +02:00
eql.rst
docs: networking: convert eql.txt to ReST
2020-04-28 14:39:46 -07:00
ethtool-netlink.rst
net: ethtool: coalesce: try to make user settings stick twice
2023-04-24 18:09:49 -07:00
failover.rst
…
fib_trie.rst
docs: networking: convert fib_trie.txt to ReST
2020-04-28 14:39:46 -07:00
filter.rst
treewide: use get_random_u32() when possible
2022-10-11 17:42:58 -06:00
gen_stats.rst
docs: networking: convert gen_stats.txt to ReST
2020-04-28 14:39:46 -07:00
generic_netlink.rst
Documentation: networking: Update generic_netlink_howto URL
2022-11-23 17:25:02 -08:00
generic-hdlc.rst
docs: networking: convert generic-hdlc.txt to ReST
2020-04-28 14:39:46 -07:00
gtp.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
ieee802154.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
ila.rst
docs: networking: convert ila.txt to ReST
2020-04-28 14:39:47 -07:00
index.rst
docs: networking: fix x25-iface.rst heading & index order
2023-05-10 10:31:46 +01:00
ioam6-sysctl.rst
ipv6: ioam: Documentation for new IOAM sysctls
2021-07-21 08:14:33 -07:00
ip_dynaddr.rst
docs: networking: convert ip_dynaddr.txt to ReST
2020-04-28 14:39:47 -07:00
ip-sysctl.rst
net: change accept_ra_min_rtr_lft to affect all RA lifetimes
2023-07-28 13:30:51 -07:00
ipddp.rst
docs: networking: convert ipddp.txt to ReST
2020-04-28 14:39:47 -07:00
ipsec.rst
docs: networking: convert ipsec.txt to ReST
2020-04-28 14:39:47 -07:00
ipv6.rst
docs: networking: convert ipv6.txt to ReST
2020-04-28 14:40:18 -07:00
ipvlan.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
ipvs-sysctl.rst
ipvs: run_estimation should control the kthread tasks
2022-12-10 22:44:43 +01:00
j1939.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
kapi.rst
wimax: move out to staging
2020-10-29 19:27:45 +01:00
kcm.rst
docs: networking: convert kcm.txt to ReST
2020-04-28 14:40:19 -07:00
l2tp.rst
Documentation: networking: correct possessive "its"
2022-08-31 12:36:08 -07:00
lapb-module.rst
docs: networking: convert lapb-module.txt to ReST
2020-04-30 12:56:35 -07:00
mac80211-auth-assoc-deauth.txt
…
mac80211-injection.rst
doc: networking: wireless: fix wiki website url
2020-06-08 10:05:53 +02:00
mctp.rst
mctp: Add SIOCMCTP{ALLOC,DROP}TAG ioctls for tag control
2022-02-09 12:00:11 +00:00
mpls-sysctl.rst
docs: networking: convert mpls-sysctl.txt to ReST
2020-04-30 12:56:36 -07:00
mptcp-sysctl.rst
Documentation: mptcp: fix pm_type formatting
2022-09-13 10:18:44 +02:00
msg_zerocopy.rst
docs: net: fix inaccuracies in msg_zerocopy.rst
2023-02-24 18:31:31 -08:00
multiqueue.rst
docs: networking: convert multiqueue.txt to ReST
2020-04-30 12:56:36 -07:00
napi.rst
docs: net: clarify the NAPI rules around XDP Tx
2023-07-21 18:51:37 -07:00
net_dim.rst
docs: networking: add full DIM API
2020-04-10 18:11:04 -07:00
net_failover.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
netconsole.rst
netconsole: Append kernel version to message
2023-07-18 11:04:59 +02:00
netdev-features.rst
net: hsr: add offloading support
2021-02-11 13:24:44 -08:00
netdevices.rst
net: bonding: move ioctl handling to private ndo operation
2021-07-27 20:11:45 +01:00
netfilter-sysctl.rst
docs: networking: convert netfilter-sysctl.txt to ReST
2020-04-30 12:56:36 -07:00
netif-msg.rst
docs: networking: convert netif-msg.txt to ReST
2020-04-30 12:56:36 -07:00
nexthop-group-resilient.rst
Documentation: net: Document resilient next-hop groups
2021-03-29 13:51:38 -07:00
nf_conntrack-sysctl.rst
Revert "net: Remove low_thresh in ip defrag"
2023-05-16 20:46:30 -07:00
nf_flowtable.rst
docs: nf_flowtable: fix compilation and warnings
2021-03-25 17:42:02 -07:00
nfc.rst
docs: networking: nfc: change to rst format
2019-11-23 11:00:19 -08:00
openvswitch.rst
docs: networking: convert openvswitch.txt to ReST
2020-04-30 12:56:36 -07:00
operstates.rst
docs: operstates: document IF_OPER_TESTING
2021-08-02 15:16:04 +01:00
packet_mmap.rst
docs: networking: Replace strncpy() with strscpy()
2021-06-04 11:21:43 -06:00
page_pool.rst
docs: net: page_pool: use kdoc to avoid duplicating the information
2023-08-03 09:54:24 -07:00
phonet.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
phy.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
pktgen.rst
pktgen: document the latest pktgen usage options
2021-08-25 13:44:30 +01:00
plip.rst
docs: networking: convert PLIP.txt to ReST
2020-04-30 12:56:37 -07:00
ppp_generic.rst
docs: update ppp_generic.rst to document new ioctls
2020-12-10 13:57:36 -08:00
proc_net_tcp.rst
docs: networking: convert proc_net_tcp.txt to ReST
2020-04-30 12:56:37 -07:00
radiotap-headers.rst
docs: networking: convert radiotap-headers.txt to ReST
2020-04-30 12:56:37 -07:00
rds.rst
Doc: networking: Fix the title's Sphinx overline in rds.rst
2021-11-29 15:18:21 -07:00
regulatory.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
representors.rst
docs: net: add an explanation of VF (and other) Representors
2022-09-21 07:31:38 -07:00
rxrpc.rst
rxrpc: Fix potential race in error handling in afs_make_call()
2023-04-22 15:16:39 +01:00
scaling.rst
sock: Remove ->sendpage*() in favour of sendmsg(MSG_SPLICE_PAGES)
2023-06-24 15:50:13 -07:00
sctp.rst
docs: networking: convert sctp.txt to ReST
2020-04-30 12:56:38 -07:00
secid.rst
docs: networking: convert secid.txt to ReST
2020-04-30 12:56:38 -07:00
seg6-sysctl.rst
doc: move seg6_flowlabel to seg6-sysctl.rst
2021-04-14 13:13:15 -07:00
segmentation-offloads.rst
networking: : fix typos in code comments
2019-05-20 20:24:34 -04:00
sfp-phylink.rst
doc: sfp-phylink: Fix a broken reference
2022-08-02 21:45:07 -07:00
skbuff.rst
skbuff: render the checksum comment to documentation
2022-05-10 17:48:37 -07:00
smc-sysctl.rst
net/smc: Unbind r/w buffer size from clcsock and make them tunable
2022-09-22 12:58:21 +02:00
snmp_counter.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
statistics.rst
docs: ethtool-netlink: document interface for MAC Merge layer
2023-01-23 12:44:18 +00:00
strparser.rst
docs: networking: convert strparser.txt to ReST
2020-04-30 12:56:38 -07:00
switchdev.rst
docs: net: add an explanation of VF (and other) Representors
2022-09-21 07:31:38 -07:00
sysfs-tagging.rst
Documentation: networking: correct spelling
2023-01-31 13:00:47 +01:00
tc-actions-env-rules.rst
docs: networking: convert tc-actions-env-rules.txt to ReST
2020-04-30 12:56:38 -07:00
tc-queue-filters.rst
Documentation: networking: TC queue based filtering
2022-10-25 10:32:40 +02:00
tcp-thin.rst
docs: networking: convert tcp-thin.txt to ReST
2020-04-30 12:56:38 -07:00
team.rst
docs: networking: convert team.txt to ReST
2020-04-30 12:56:38 -07:00
timestamping.rst
net_tstamp: add SOF_TIMESTAMPING_OPT_ID_TCP
2022-12-08 19:49:21 -08:00
tipc.rst
Documentation: add more details in tipc.rst
2021-07-01 13:18:18 -07:00
tls-handshake.rst
net/handshake: Enable the SNI extension to work properly
2023-05-24 22:05:24 -07:00
tls-offload-layers.svg
Documentation: add TLS offload documentation
2019-05-22 12:18:20 -07:00
tls-offload-reorder-bad.svg
Documentation: add TLS offload documentation
2019-05-22 12:18:20 -07:00
tls-offload-reorder-good.svg
Documentation: add TLS offload documentation
2019-05-22 12:18:20 -07:00
tls-offload.rst
net: Disable NETIF_F_HW_TLS_RX when RXCSUM is disabled
2021-01-19 15:58:05 -08:00
tls.rst
tls: rx: add counter for NoPad violations
2022-07-11 19:48:33 -07:00
tproxy.rst
docs: networking: convert tproxy.txt to ReST
2020-04-30 12:56:38 -07:00
tuntap.rst
docs: networking: Replace strncpy() with strscpy()
2021-06-04 11:21:43 -06:00
udplite.rst
docs: networking: convert udplite.txt to ReST
2020-05-01 12:24:40 -07:00
vrf.rst
doc: Document unexpected tcp_l3mdev_accept=1 behavior
2021-08-23 11:53:24 +01:00
vxlan.rst
docs: vxlan: add info about device features
2020-09-28 12:50:12 -07:00
x25-iface.rst
docs: networking: fix x25-iface.rst heading & index order
2023-05-10 10:31:46 +01:00
x25.rst
net: x25: Remove unimplemented X.25-over-LLC code stubs
2020-12-12 17:15:33 -08:00
xdp-rx-metadata.rst
xdp: bpf_xdp_metadata use EOPNOTSUPP for no driver support
2023-03-22 09:11:09 -07:00
xfrm_device.rst
xfrm: extend add state callback to set failure reason
2023-01-26 16:28:48 -08:00
xfrm_proc.rst
docs: networking: convert xfrm_proc.txt to ReST
2020-05-01 12:24:40 -07:00
xfrm_sync.rst
docs: networking: convert xfrm_sync.txt to ReST
2020-05-01 12:24:41 -07:00
xfrm_sysctl.rst
docs: networking: convert xfrm_sysctl.txt to ReST
2020-05-01 12:24:41 -07:00