diff mbox

[v2,next,1/3] batman-adv: add missing kernel doc

Message ID 1454308474-23211-1-git-send-email-mareklindner@neomailbox.ch (mailing list archive)
State Accepted, archived
Commit ec7952f329c3e9fb8efc3945bb59ae2448c27612
Headers

Commit Message

Marek Lindner Feb. 1, 2016, 6:34 a.m. UTC 
  Fixes: 5c324517 ("ELP - compute the metric based on the estimated throughput")

Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
---
 net/batman-adv/bat_v_elp.c | 3 ++-
 net/batman-adv/main.h      | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

Comments

Marek Lindner Feb. 10, 2016, 10:19 a.m. UTC | #1 
On Monday, February 01, 2016 14:34:32 Marek Lindner wrote:
> Fixes: 5c324517 ("ELP - compute the metric based on the estimated
> throughput")
> 
> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
> ---
>  net/batman-adv/bat_v_elp.c | 3 ++-
>  net/batman-adv/main.h      | 2 +-
>  2 files changed, 3 insertions(+), 2 deletions(-)

Applied in revision ec7952f.

Regards,
Marek
diff mbox

Patch

diff --git a/net/batman-adv/bat_v_elp.c b/net/batman-adv/bat_v_elp.c
index f257897..46c6a00 100644
--- a/net/batman-adv/bat_v_elp.c
+++ b/net/batman-adv/bat_v_elp.c
@@ -67,7 +67,8 @@  static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
  * batadv_v_elp_get_throughput - get the throughput towards a neighbour
  * @neigh: the neighbour for which the throughput has to be obtained
  *
- * Return: the throughput towards the given neighbour.
+ * Return: The throughput towards the given neighbour in multiples of 100kpbs
+ *         (a value of '1' equals to 0.1Mbps, '10' equals 1Mbps, etc).
  */
 static u32 batadv_v_elp_get_throughput(struct batadv_hardif_neigh_node *neigh)
 {
diff --git a/net/batman-adv/main.h b/net/batman-adv/main.h
index 7b05f68..db45336 100644
--- a/net/batman-adv/main.h
+++ b/net/batman-adv/main.h
@@ -62,7 +62,7 @@ 
 #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
 
 /* B.A.T.M.A.N. V */
-#define BATADV_THROUGHPUT_DEFAULT_VALUE 10
+#define BATADV_THROUGHPUT_DEFAULT_VALUE 10 /* 1 Mbps */
 #define BATADV_ELP_PROBES_PER_NODE 2
 #define BATADV_ELP_MIN_PROBE_SIZE 200 /* bytes */
 #define BATADV_ELP_PROBE_MAX_TX_DIFF 100 /* milliseconds */