Hi,
just some things that came to my mind after reading Ben Hutchings patch.
On Saturday 14 July 2012 01:41:43 Antonio Quartulli wrote:
+/**
- batadv_prepare_unicast_packet - encapsulate an skb with a unicast header
- @skb: the skb containing the payload to encapsulate
- @orig_node: the destination node
- Returns false if the payload could not be encapsulated or true otherwise
- */
http://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt
No blank line between "function_name(:)? (- short description)?" and "@parameterx(space)*: (description of parameter x)?)*"
+struct batadv_unicast_4addr_packet {
struct batadv_unicast_packet u;uint8_t src[ETH_ALEN];uint8_t subtype;+} __packed;
Where is the kerneldoc for "struct batadv_unicast_4addr_packet"?
+/**
- batadv_dht_select_candidates - given a key, selects the candidates which the
- DHT message has to be sent to. An originator O is selected if and only if
- its DHT_ID value is one of three closest values (from the LEFT, with wrap
- around if needed) then the hash value of the key. ip_dst is the key.
- @bat_priv: the bat priv with all the soft interface information
- @ip_dst: ipv4 to look up in the DHT
- Returns the candidate array of size DHT_CANDIDATE_NUM
- */
+static struct batadv_dht_candidate * +batadv_dht_select_candidates(struct batadv_priv *bat_priv, __be32 ip_dst) +{
Please use the correct order:
/** * function_name(:)? (- short description)? (* @parameterx(space)*: (description of parameter x)?)* (* a blank line)? * (Description:)? (Description of function)? * (section header: (section description)? )* (*)?*/
And I think we should add () for function names and prepend "struct " for structs, ...
Kind regards, Sven