diff mbox

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

Message ID 1454257280-19649-1-git-send-email-mareklindner@neomailbox.ch (mailing list archive)
State Superseded, archived
Headers

Commit Message

Marek Lindner Jan. 31, 2016, 4:21 p.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

Antonio Quartulli Feb. 1, 2016, 12:44 a.m. UTC | #1 
On Mon, Feb 01, 2016 at 12:21:18AM +0800, Marek Lindner wrote:
> Fixes: 5c324517 ("ELP - compute the metric based on the estimated throughput")
> 
> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>

Acked-by: Antonio Quartulli <a@unstable.cc>
Antonio Quartulli Feb. 1, 2016, 12:46 a.m. UTC | #2 
On Mon, Feb 01, 2016 at 12:21:19AM +0800, Marek Lindner wrote:
> Fixes: 5c324517 ("ELP - compute the metric based on the estimated throughput")
> 
> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>

Maybe before merging this patch you add a one line commit message here saying
that expected_throughput is supposed to be expressed in kbps, therefore this
fix is required ?

Other than that:
Acked-by: Antonio Quartulli <a@unstable.cc>
Marek Lindner Feb. 1, 2016, 1:39 a.m. UTC | #3 
On Monday, February 01, 2016 08:46:23 Antonio Quartulli wrote:
> On Mon, Feb 01, 2016 at 12:21:19AM +0800, Marek Lindner wrote:
> > Fixes: 5c324517 ("ELP - compute the metric based on the estimated
> > throughput")>
> > 
> >
> > Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
> 
> Maybe before merging this patch you add a one line commit message here
> saying that expected_throughput is supposed to be expressed in kbps,
> therefore this fix is required ?

As we haven't sent the offending patch upstream yet, you can simply merge all 
3 fixes into "ELP - compute the metric based on the estimated throughput" and 
be done with it. This patch isn't for stable ...

Cheers,
Marek
Antonio Quartulli Feb. 1, 2016, 2:15 a.m. UTC | #4 
On Mon, Feb 01, 2016 at 09:39:33AM +0800, Marek Lindner wrote:
> On Monday, February 01, 2016 08:46:23 Antonio Quartulli wrote:
> > On Mon, Feb 01, 2016 at 12:21:19AM +0800, Marek Lindner wrote:
> > > Fixes: 5c324517 ("ELP - compute the metric based on the estimated
> > > throughput")>
> > > 
> > >
> > > Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
> > 
> > Maybe before merging this patch you add a one line commit message here
> > saying that expected_throughput is supposed to be expressed in kbps,
> > therefore this fix is required ?
> 
> As we haven't sent the offending patch upstream yet, you can simply merge all 
> 3 fixes into "ELP - compute the metric based on the estimated throughput" and 
> be done with it. This patch isn't for stable ...

Sure, but I was talking about our repository, just to have a better
understanding of this patch in the future. But if you think we don't need any
description it's fine.


Cheers,
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 '10' equals to 1Mbps).
  */
 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 */