batman-adv: bat_iv: fix ogm_neigh_is_sob parameters references

The batadv_iv_ogm_neigh_is_sob() kernel-doc summary line is still
referencing the old parameter names "neigh1" and "neigh2". But these are
now called "candidate" and "reference".

Reported-by: Sashiko <sashiko-bot@kernel.org>
Closes: https://netdev-ai.bots.linux.dev/sashiko/#/patchset/20260831135117.574836-1-sw%40simonwunderlich.de?part=5
Signed-off-by: Sven Eckelmann <sven@narfation.org>
This commit is contained in:
Sven Eckelmann 2026-09-01 19:14:49 +02:00
parent 857fbd765c
commit 271f3730fc
No known key found for this signature in database
GPG Key ID: 4D0F772BD314F5CB

View File

@ -2422,8 +2422,8 @@ static int batadv_iv_ogm_neigh_cmp(struct batadv_neigh_node *neigh1,
}
/**
* batadv_iv_ogm_neigh_is_sob() - check if neigh1 is similarly good or better
* than neigh2 from the metric prospective
* batadv_iv_ogm_neigh_is_sob() - check if @candidate is similarly good or
* better than @reference from the metric prospective
* @candidate: the first neighbor object of the comparison
* @if_outgoing_cand: outgoing interface for the @candidate neighbor
* @reference: the second neighbor object of the comparison