From a4e6f7b68ca9f82b920315cadb8db3cb01be4e6b Mon Sep 17 00:00:00 2001
From: Hungming Chen <nuccachen@google.com>
Date: Tue, 12 May 2020 19:15:24 +0800
Subject: [PATCH] A minor followup change for BPF offload device option stuff

- Correct description and spelling in the code and xml files.
- Add a TODO for refactoring the IpServer constructor.
- Refine the if-statement for starting IP neighbor monitor.

Test: atest IpServerTest
Change-Id: If9c8bc6f785fa80575db56de4e223292e9807ace
---
 packages/Tethering/res/values/config.xml            |  2 +-
 packages/Tethering/res/values/overlayable.xml       |  2 +-
 packages/Tethering/src/android/net/ip/IpServer.java | 12 ++++++------
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/packages/Tethering/res/values/config.xml b/packages/Tethering/res/values/config.xml
index 0ea459a6cfe5f..3f5bc901d07bc 100644
--- a/packages/Tethering/res/values/config.xml
+++ b/packages/Tethering/res/values/config.xml
@@ -57,7 +57,7 @@
 
     <!-- Use the BPF offload for tethering when the kernel has support. True by default.
          If the device doesn't want to support tether BPF offload, this should be false.
-         Note that this setting could be override by device config.
+         Note that this setting could be overridden by device config.
     -->
     <bool translatable="false" name="config_tether_enable_bpf_offload">true</bool>
 
diff --git a/packages/Tethering/res/values/overlayable.xml b/packages/Tethering/res/values/overlayable.xml
index 288dd5ddf3f89..4e2bb1e31b2a0 100644
--- a/packages/Tethering/res/values/overlayable.xml
+++ b/packages/Tethering/res/values/overlayable.xml
@@ -25,7 +25,7 @@
             <item type="array" name="config_tether_dhcp_range"/>
             <!-- Use the BPF offload for tethering when the kernel has support. True by default.
                  If the device doesn't want to support tether BPF offload, this should be false.
-                 Note that this setting could be override by device config.
+                 Note that this setting could be overridden by device config.
             -->
             <item type="bool" name="config_tether_enable_bpf_offload"/>
             <item type="bool" name="config_tether_enable_legacy_dhcp_server"/>
diff --git a/packages/Tethering/src/android/net/ip/IpServer.java b/packages/Tethering/src/android/net/ip/IpServer.java
index ca485f5da55b4..d993306b171aa 100644
--- a/packages/Tethering/src/android/net/ip/IpServer.java
+++ b/packages/Tethering/src/android/net/ip/IpServer.java
@@ -303,6 +303,8 @@ public class IpServer extends StateMachine {
 
     private final IpNeighborMonitor mIpNeighborMonitor;
 
+    // TODO: Add a dependency object to pass the data members or variables from the tethering
+    // object. It helps to reduce the arguments of the constructor.
     public IpServer(
             String ifaceName, Looper looper, int interfaceType, SharedLog log,
             INetd netd, Callback callback, boolean usingLegacyDhcp, boolean usingBpfOffload,
@@ -325,14 +327,12 @@ public class IpServer extends StateMachine {
         mIpNeighborMonitor = mDeps.getIpNeighborMonitor(getHandler(), mLog,
                 new MyNeighborEventConsumer());
 
-        // IP neighbor monitor monitors the neighbor event for adding/removing offload
+        // IP neighbor monitor monitors the neighbor events for adding/removing offload
         // forwarding rules per client. If BPF offload is not supported, don't start listening
-        // neighbor events. See updateIpv6ForwardingRules, addIpv6ForwardingRule,
+        // for neighbor events. See updateIpv6ForwardingRules, addIpv6ForwardingRule,
         // removeIpv6ForwardingRule.
-        if (mUsingBpfOffload) {
-            if (!mIpNeighborMonitor.start()) {
-                mLog.e("Failed to create IpNeighborMonitor on " + mIfaceName);
-            }
+        if (mUsingBpfOffload && !mIpNeighborMonitor.start()) {
+            mLog.e("Failed to create IpNeighborMonitor on " + mIfaceName);
         }
 
         mInitialState = new InitialState();