maintenance: format comments with ocamlformat

psafont · psafont · commit 758238943e49 · 2020-05-18T14:55:48.000+01:00
This is done after adding wrap-comments=true in .ocamlformat

Signed-off-by: Pau Ruiz Safont &lt;pau.safont@citrix.com&gt;
diff --git a/lib/jsonrpc_client.ml b/lib/jsonrpc_client.ml
@@ -49,9 +49,9 @@ let timeout_read fd timeout =
       | Unix.Unix_error (Unix.EINTR, _, _) ->
         ([], [], [])
     in
-    (* This is not accurate the calculate time just for the select part. However, we
-       		 * think the read time will be minor comparing to the scale of tens of seconds.
-       		 * the current style will be much concise in code. *)
+    (* This is not accurate the calculate time just for the select part.
+       However, we think the read time will be minor comparing to the scale of
+       tens of seconds. the current style will be much concise in code. *)
     let remain_time =
       let used_time = get_total_used_time () in
       Int64.sub timeout used_time
@@ -84,8 +84,10 @@ let timeout_read fd timeout =
   in
   inner timeout !json_rpc_max_len
 
-(* Write as many bytes to a file descriptor as possible from data before a given clock time. *)
-(* Raises Timeout exception if the number of bytes written is less than the specified length. *)
+(* Write as many bytes to a file descriptor as possible from data before a given
+   clock time. *)
+(* Raises Timeout exception if the number of bytes written is less than the
+   specified length. *)
 (* Writes into the file descriptor at the current cursor position. *)
 let timeout_write filedesc total_length data response_time =
   let write_start = Mtime_clock.counter () in
diff --git a/lib/jsonrpc_client.mli b/lib/jsonrpc_client.mli
@@ -30,5 +30,5 @@ val with_rpc :
   -> call:Rpc.call
   -> unit
   -> Rpc.response
-(** Do an JSON-RPC call to a server that is listening on a Unix domain 
- *  socket at the given path. *)
+(** Do an JSON-RPC call to a server that is listening on a Unix domain socket at
+    the given path. *)
diff --git a/lib/network_config.ml b/lib/network_config.ml
@@ -178,7 +178,8 @@ let write_config config =
       (Printexc.get_backtrace ()) ;
     raise Write_error
 
-(* Porting network interaface to ppx: convert ipv4_routes from (string * int * string) list to {gateway:string; netmask:int; subnet:string} *)
+(* Porting network interaface to ppx: convert ipv4_routes from [(string * int *
+   string) list] to [{gateway:string; netmask:int; subnet:string}] *)
 let convert_configuration cfg =
   let open Yojson.Safe in
   let convert_ipv4_routes cfg =
diff --git a/lib/network_utils.ml b/lib/network_utils.ml
@@ -188,7 +188,8 @@ module Sysfs = struct
     try
       let devpath = getpath name "device" in
       let driver_link = Unix.readlink (devpath ^ "/driver") in
-      (* filter out symlinks under device/driver which look like /../../../devices/xen-backend/vif- *)
+      (* filter out symlinks under device/driver which look like
+         /../../../devices/xen-backend/vif- *)
       not
         (List.mem "xen-backend"
            (Astring.String.cuts ~empty:false ~sep:"/" driver_link))
@@ -239,8 +240,8 @@ module Sysfs = struct
         Result.Error
           (Fail_to_get_driver_name, "Failed to get driver name for: " ^ dev)
 
-  (** Returns the features bitmap for the driver for [dev].
-      	 *  The features bitmap is a set of NETIF_F_ flags supported by its driver. *)
+  (** Returns the features bitmap for the driver for [dev]. The features bitmap
+      is a set of NETIF_F_ flags supported by its driver. *)
   let get_features dev =
     try Some (int_of_string (read_one_line (getpath dev "features")))
     with _ -> None
@@ -274,9 +275,11 @@ module Sysfs = struct
     let ifaces = list () in
     List.filter (fun name -> Sys.file_exists (getpath name "bridge")) ifaces
 
-  (** Returns (speed, duplex) for a given network interface: int megabits/s, Duplex.
-      	 *  The units of speed are specified in pif_record in xen-api/xapi/records.ml.
-      	 *  Note: these data are present in sysfs from kernel 2.6.33. *)
+  (** Returns (speed, duplex) for a given network interface: int megabits/s,
+      Duplex. The units of speed are specified in pif_record in
+      xen-api/xapi/records.ml.
+
+      Note: these data are present in sysfs from kernel 2.6.33. *)
   let get_status name =
     let speed =
       getpath name "speed" |> fun p ->
@@ -653,7 +656,8 @@ module Ip = struct
     with _ ->
       Result.Error (Fail_to_set_vf_vlan, "Failed to set VF VLAN for: " ^ dev)
 
-  (* We know some NICs do not support config VF Rate, so will explicitly tell XAPI this error*)
+  (* We know some NICs do not support config VF Rate, so will explicitly tell
+     XAPI this error*)
   let set_vf_rate dev index rate =
     try
       debug "Setting VF rate for dev: %s, index: %d, rate: %d" dev index rate ;
@@ -670,9 +674,10 @@ module Linux_bonding = struct
     debug "Loading bonding driver" ;
     try
       ignore (call_script modprobe ["bonding"]) ;
-      (* is_bond_device() uses the contents of sysfs_bonding_masters to work out which devices
-         			 * have already been created. Unfortunately the driver creates "bond0" automatically at
-         			 * modprobe init. Get rid of this now or our accounting will go wrong. *)
+      (* is_bond_device() uses the contents of sysfs_bonding_masters to work out
+         which devices have already been created. Unfortunately the driver
+         creates "bond0" automatically at modprobe init. Get rid of this now or
+         our accounting will go wrong. *)
       Sysfs.write_one_line bonding_masters "-bond0"
     with _ -> error "Failed to load bonding driver"
 
@@ -822,8 +827,8 @@ module Linux_bonding = struct
       debug "Current bond properties: %s"
         (String.concat ", "
            (List.map (fun (k, v) -> k ^ "=" ^ v) current_props)) ;
-      (* Find out which properties are known, but different from the current state,
-         			 * and only continue if there is at least one of those. *)
+      (* Find out which properties are known, but different from the current
+         state, and only continue if there is at least one of those. *)
       let props_to_update =
         List.filter
           (fun (prop, value) ->
@@ -986,7 +991,8 @@ end = struct
       (* dhclient is not running, so we need to start it. *)
       ignore (start ~ipv6 interface options)
     else
-      (* dhclient is running - if the config has changed, update the config file and restart. *)
+      (* dhclient is running - if the config has changed, update the config file
+         and restart. *)
       let current_conf = read_conf_file ~ipv6 interface in
       let new_conf = generate_conf ~ipv6 interface options in
       if current_conf <> Some new_conf then (
@@ -1251,13 +1257,13 @@ module Ovs = struct
       with _ -> warn "Failed to set max-idle=%d on OVS" t
 
     let handle_vlan_bug_workaround override bridge =
-      (* This is a list of drivers that do support VLAN tx or rx acceleration, but
-         		 * to which the VLAN bug workaround should not be applied. This could be
-         		 * because these are known-good drivers (that is, they do not have any of
-         		 * the bugs that the workaround avoids) or because the VLAN bug workaround
-         		 * will not work for them and may cause other problems.
-         		 *
-         		 * This is a very short list because few drivers have been tested. *)
+      (* This is a list of drivers that do support VLAN tx or rx acceleration,
+         but to which the VLAN bug workaround should not be applied. This could
+         be because these are known-good drivers (that is, they do not have any
+         of the bugs that the workaround avoids) or because the VLAN bug
+         workaround will not work for them and may cause other problems.
+
+         This is a very short list because few drivers have been tested. *)
       let no_vlan_workaround_drivers = ["bonding"] in
       let phy_interfaces =
         try
@@ -1357,7 +1363,9 @@ module Ovs = struct
             (fun vif -> Astring.String.is_prefix ~affix:"vif" vif)
             bvifs
         in
-        (* The vifs may be large. However considering current XS limit of 1000VM*7NIC/VM + 800VLANs, the buffer of CLI should be sufficient for lots of vifxxxx.xx *)
+        (* The vifs may be large. However considering current XS limit of
+           1000VM*7NIC/VM + 800VLANs, the buffer of CLI should be sufficient for
+           lots of vifxxxx.xx *)
         fork_script !inject_igmp_query_script
           ([
              "--no-check-snooping-toggle"
@@ -1493,14 +1501,16 @@ module Ovs = struct
       let del_old_arg =
         let real_bridge_exists () =
           try
-            (* `ovs-vsctl br-to-parent <name>` returns <name> if <name> is a current "real" bridge *)
+            (* `ovs-vsctl br-to-parent <name>` returns <name> if <name> is a
+               current "real" bridge *)
             vsctl ~log:false ["br-to-parent"; name] |> String.trim = name
           with _ -> false
         in
         if vlan <> None && real_bridge_exists () then
-          (* This is to handle the case that a "real" bridge (not a "fake" VLAN bridge)
-             already exists, while we need to create a VLAN bridge with the same name.
-             The bridge will be destroyed and recreated, and the interfaces on it are put back. *)
+          (* This is to handle the case that a "real" bridge (not a "fake" VLAN
+             bridge) already exists, while we need to create a VLAN bridge with
+             the same name. The bridge will be destroyed and recreated, and the
+             interfaces on it are put back. *)
           ["--"; "--if-exists"; "del-br"; name]
         else
           []
@@ -1882,19 +1892,19 @@ module Modprobe = struct
         ( Fail_to_write_modprobe_cfg
         , "Failed to write modprobe configuration file for: " ^ driver )
 
-  (*
-    For a igb driver, the module config file will be at path `/etc/modprobe.d/igb.conf`
-    The module config file is like:
-    # VFs-param: max_vfs
-    # VFs-maxvfs-by-default: 7
-    # VFs-maxvfs-by-user:
-    options igb max_vfs=7,7
-
-    Example of calls:
-    "igb" -> "VFs-param" -> Some "max_vfs"
-    "igb" -> "VFs-maxvfs-by-default" -> Some "7"
-    "igb" -> "VFs-maxvfs-by-user" -> None
-    "igb" -> "Not existed comments" -> None
+  (* For a igb driver, the module config file will be at path
+     `/etc/modprobe.d/igb.conf`
+
+     The module config file is like:
+     # VFs-param: max_vfs
+     # VFs-maxvfs-by-default: 7
+     # VFs-maxvfs-by-user: options igb max_vfs=7,7
+
+     Example of calls:
+     "igb" -> "VFs-param" -> Some "max_vfs"
+     "igb" -> "VFs-maxvfs-by-default" -> Some "7"
+     "igb" -> "VFs-maxvfs-by-user" -> None
+     "igb" -> "Not existed comments" -> None
   *)
   let get_config_from_comments driver =
     try
@@ -1917,11 +1927,12 @@ module Modprobe = struct
                    Some (String.trim k, String.trim v))
     with _ -> []
 
-  (* this function not returning None means that the driver doesn't suppport sysfs.
-     	If a driver doesn't support sysfs, then we add VF_param into its driver modprobe
-     	configuration. Therefore, from XAPI's perspective, if Modprobe.get_vf_param is
-     	not None, the driver definitely should use modprobe other than sysfs,
-     	and if Modprobe.get_vf_param is None, we just simple try sysfs. *)
+  (* this function not returning None means that the driver doesn't suppport
+     sysfs. If a driver doesn't support sysfs, then we add VF_param into its
+     driver modprobe configuration. Therefore, from XAPI's perspective, if
+     Modprobe.get_vf_param is not None, the driver definitely should use
+     modprobe other than sysfs, and if Modprobe.get_vf_param is None, we just
+     simple try sysfs. *)
   let get_vf_param config =
     try Some (List.assoc "VFs-param" config) with _ -> None
 
@@ -1946,11 +1957,11 @@ module Modprobe = struct
   let config_sriov driver vf_param maxvfs =
     let open Rresult.R.Infix in
     Modinfo.is_param_array driver vf_param >>= fun is_array ->
-    (* To enable SR-IOV via modprobe configuration, we first determine if the driver requires
-       		in the configuration an array like `options igb max_vfs=7,7,7,7` or a single value
-       		like `options igb max_vfs=7`. If an array is required, this repeat times equals to
-       		the number of devices with the same driver.
-    *)
+    (* To enable SR-IOV via modprobe configuration, we first determine if the
+       driver requires in the configuration an array like `options igb
+       max_vfs=7,7,7,7` or a single value like `options igb max_vfs=7`. If an
+       array is required, this repeat times equals to the number of devices with
+       the same driver. *)
     let repeat =
       if is_array then Sysfs.get_dev_nums_with_same_driver driver else 1
     in
@@ -1969,7 +1980,8 @@ module Modprobe = struct
     let parse_single_line s =
       let parse_driver_options s =
         match Astring.String.cut ~sep:"=" s with
-        (* has SR-IOV configuration but the max_vfs is exactly what we want to set, so no changes and return s *)
+        (* has SR-IOV configuration but the max_vfs is exactly what we want to
+           set, so no changes and return s *)
         | Some (k, v) when k = vf_param && v = option ->
             has_probe_conf := true ;
             s
diff --git a/networkd/network_monitor_thread.ml b/networkd/network_monitor_thread.ml
@@ -128,7 +128,7 @@ let get_link_stats () =
     in
     List.map (fun link -> (standardise_name (Link.get_name link), link)) links
     |> (* Only keep interfaces with prefixes on the whitelist, and exclude VLAN
-          		   devices (ethx.y). *)
+          devices (ethx.y). *)
     List.filter (fun (name, _) -> is_whitelisted name && not (is_vlan name))
   in
   let devs =
@@ -382,7 +382,7 @@ let rec ip_watcher () =
       && not (Astring.String.is_infix ~affix:"inet6 fe80" line)
     then (
       (* Ignore changes for the next second, since they usually come in bursts,
-         			 * and signal only once. *)
+         * and signal only once. *)
       Thread.delay 1. ;
       clear_input readme ;
       signal_networking_change ()
diff --git a/networkd/network_server.ml b/networkd/network_server.ml
@@ -127,10 +127,10 @@ module Sriov = struct
         debug "%s SR-IOV on a device: %s via modprobe" op dev ;
         (if enable then Modprobe.get_maxvfs driver config else Ok 0)
         >>= fun numvfs ->
-        (* CA-287340: Even if the current numvfs equals to the target numvfs,
-           			it is still needed to update SR-IOV modprobe config file, as the
-           			SR-IOV enabing takes effect after reboot. For example, a user
-           			enables SR-IOV and disables it immediately without a reboot.*)
+        (* CA-287340: Even if the current numvfs equals to the target numvfs, it
+           is still needed to update SR-IOV modprobe config file, as the SR-IOV
+           enabing takes effect after reboot. For example, a user enables SR-IOV
+           and disables it immediately without a reboot.*)
         Modprobe.config_sriov driver vf_param numvfs >>= fun _ ->
         if numvfs = Sysfs.get_sriov_numvfs dev then
           Ok Modprobe_successful
@@ -184,9 +184,11 @@ module Sriov = struct
       (fun () -> Result.Ok ())
       mac
     >>= fun () ->
-    (* In order to ensure the Networkd to be idempotent, configuring VF with no VLAN and rate
-       		have to reset vlan and rate, since the VF might have previous configuration. Refering to
-       		http://gittup.org/cgi-bin/man/man2html?ip-link+8, set VLAN and rate to 0 means to reset them *)
+    (* In order to ensure the Networkd to be idempotent, configuring VF with no
+       VLAN and rate have to reset vlan and rate, since the VF might have
+       previous configuration. Refering to
+       http://gittup.org/cgi-bin/man/man2html?ip-link+8, set VLAN and rate to 0
+       means to reset them *)
     config_or_otherwise_reset (Ip.set_vf_vlan dev index)
       (fun () -> Ip.set_vf_vlan dev index 0)
       vlan
@@ -285,8 +287,8 @@ module Interface = struct
               ignore (Dhclient.stop name) ;
               Ip.flush_ip_addr name
             ) ;
-            (* the function is meant to be idempotent and we
-               				 * want to avoid CA-239919 *)
+            (* the function is meant to be idempotent and we want to avoid
+               CA-239919 *)
             let cur_addrs = Ip.get_ipv4 name in
             let rm_addrs =
               Xapi_stdext_std.Listext.List.set_difference cur_addrs addrs
@@ -372,7 +374,8 @@ module Interface = struct
               Ip.flush_ip_addr ~ipv6:true name ;
               Ip.set_ipv6_link_local_addr name ;
               Sysctl.set_ipv6_autoconf name true
-              (* Cannot link set down/up due to CA-89882 - IPv4 default route cleared *)
+              (* Cannot link set down/up due to CA-89882 - IPv4 default route
+                 cleared *)
           | Static6 addrs ->
               if Dhclient.is_running ~ipv6:true name then
                 ignore (Dhclient.stop ~ipv6:true name) ;
@@ -636,9 +639,11 @@ module Interface = struct
                 ) ) ->
                 update_config name c ;
                 exec (fun () ->
-                    (* We only apply the DNS settings when in static IPv4 mode to avoid conflicts with DHCP mode.
-                       					 * The `dns` field should really be an option type so that we don't have to derive the intention
-                       					 * of the caller by looking at other fields. *)
+                    (* We only apply the DNS settings when in static IPv4 mode
+                       to avoid conflicts with DHCP mode. * The `dns` field
+                       should really be an option type so that we don't have to
+                       derive the intention * of the caller by looking at other
+                       fields. *)
                     match ipv4_conf with
                     | Static4 _ ->
                         set_dns () dbg ~name ~nameservers ~domains
@@ -899,8 +904,9 @@ module Bridge = struct
                 (* Check if the VLAN is already in use by something else *)
                 List.iter
                   (fun (device, vlan', parent') ->
-                    (* A device for the same VLAN (parent + tag), but with a different
-                       						 * device name or not on the requested bridge is bad. *)
+                    (* A device for the same VLAN (parent + tag), but with a
+                       different * device name or not on the requested bridge is
+                       bad. *)
                     if
                       parent' = parent
                       && vlan' = vlan
@@ -910,7 +916,8 @@ module Bridge = struct
                     then
                       raise (Network_error (Vlan_in_use (parent, vlan))))
                   (Proc.get_vlans ()) ;
-                (* Robustness enhancement: ensure there are no other VLANs in the bridge *)
+                (* Robustness enhancement: ensure there are no other VLANs in
+                   the bridge *)
                 let current_interfaces =
                   List.filter
                     (fun n ->
@@ -1378,8 +1385,8 @@ let on_startup () =
     (fun () ->
       Bridge.determine_backend () ;
       let remove_centos_config () =
-        (* Remove DNSDEV and GATEWAYDEV from Centos networking file, because the interfere
-           			 * with this daemon. *)
+        (* Remove DNSDEV and GATEWAYDEV from Centos networking file, because the
+           interfere * with this daemon. *)
         try
           let file =
             String.trim
diff --git a/profiling/coverage.ml b/profiling/coverage.ml
@@ -1,10 +1,8 @@
-(** This module sets up the env variable for bisect_ppx which describes
- *  where log files are written.
-*)
+(** This module sets up the env variable for bisect_ppx which describes where
+    log files are written. *)
 
-(** [init name] sets up coverage profiling for binary [name]. You could 
- *  use [Sys.argv.(0)] for [name].
-*)
+(** [init name] sets up coverage profiling for binary [name]. You could use
+    [Sys.argv.(0)] for [name]. *)
 
 let init name =
   let ( // ) = Filename.concat in
diff --git a/profiling/coverage.mli b/profiling/coverage.mli
@@ -1,5 +1,4 @@
-(** [init name] sets up coverage profiling for binary [name]. You could 
- *  use [Sys.argv.(0) for name
-*)
+(** [init name] sets up coverage profiling for binary [name]. You could use
+    [Sys.argv.(0) for name *)
 
 val init : string -> unit
diff --git a/test/network_test_lacp_properties.ml b/test/network_test_lacp_properties.ml
diff --git a/test/test_jsonrpc_client.ml b/test/test_jsonrpc_client.ml
