[B.A.T.M.A.N.] [PATCH] batman-adv: Document optional batadv_algo_ops

[B.A.T.M.A.N.] [PATCH] batman-adv: Document optional batadv_algo_ops

[Sven Eckelmann]

Some operations in batadv_algo_ops are optional and marked as such in the
kerneldoc. But some of them miss the "(optional)" in their kerneldoc. These
have to also be marked to give an implementor of an algorithm the correct
background information without looking in the code calling these function
pointers.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
---
 net/batman-adv/types.h | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index 43db7b6..0eeb68f 100644
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -1392,6 +1392,7 @@ struct batadv_forw_packet {
 /**
  * struct batadv_algo_iface_ops - mesh algorithm callbacks (interface specific)
  * @activate: start routing mechanisms when hard-interface is brought up
+ *  (optional)
  * @enable: init routing info when hard-interface is enabled
  * @disable: de-init routing info when hard-interface is disabled
  * @update_mac: (re-)init mac addresses of the protocol information
@@ -1409,6 +1410,7 @@ struct batadv_algo_iface_ops {
 /**
  * struct batadv_algo_neigh_ops - mesh algorithm callbacks (neighbour specific)
  * @hardif_init: called on creation of single hop entry
+ *  (optional)
  * @cmp: compare the metrics of two neighbors for their respective outgoing
  *  interfaces
  * @is_similar_or_better: check if neigh1 is equally similar or better than
@@ -1431,11 +1433,11 @@ struct batadv_algo_neigh_ops {
 /**
  * struct batadv_algo_orig_ops - mesh algorithm callbacks (originator specific)
  * @free: free the resources allocated by the routing algorithm for an orig_node
- *  object
+ *  object (optional)
  * @add_if: ask the routing algorithm to apply the needed changes to the
- *  orig_node due to a new hard-interface being added into the mesh
+ *  orig_node due to a new hard-interface being added into the mesh (optional)
  * @del_if: ask the routing algorithm to apply the needed changes to the
- *  orig_node due to an hard-interface being removed from the mesh
+ *  orig_node due to an hard-interface being removed from the mesh (optional)
  * @print: print the originator table (optional)
  */
 struct batadv_algo_orig_ops {
-- 
2.8.1

Re: [B.A.T.M.A.N.] [PATCH] batman-adv: Document optional batadv_algo_ops

[Marek Lindner]

[-- Attachment #1: Type: text/plain, Size: 572 bytes --]

On Tuesday, June 07, 2016 22:44:53 Sven Eckelmann wrote:
> Some operations in batadv_algo_ops are optional and marked as such in the
> kerneldoc. But some of them miss the "(optional)" in their kerneldoc. These
> have to also be marked to give an implementor of an algorithm the correct
> background information without looking in the code calling these function
> pointers.
> 
> Signed-off-by: Sven Eckelmann <sven@narfation.org>
> ---
>  net/batman-adv/types.h | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)

Applied in revision d6f42a6.

Thanks,
Marek

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 473 bytes --]