From ec317431c4f14e517cef15392799ee51b938d86d Mon Sep 17 00:00:00 2001 From: Pratik Patil Date: Thu, 18 Aug 2022 02:42:16 -0600 Subject: [PATCH] Fixed codacy formatting issues Signed-off-by: Pratik Patil --- doc/FOPFOM-Programming-Guide.md | 6 ++++-- doc/HLD-OF-Motr-LNet-Transport.md | 2 +- doc/HLD-of-Catalogue-Service.md | 2 +- doc/Motr-Lnet-Transport.md | 2 +- doc/Running_Motr_Across_a_Cluster.md | 11 +++++++---- doc/motr-object-app.md | 3 +-- 6 files changed, 15 insertions(+), 11 deletions(-) diff --git a/doc/FOPFOM-Programming-Guide.md b/doc/FOPFOM-Programming-Guide.md index 1cf5196aed7..428356e8923 100644 --- a/doc/FOPFOM-Programming-Guide.md +++ b/doc/FOPFOM-Programming-Guide.md @@ -43,9 +43,10 @@ record { u64 f_seq; u64 f_oid } reqh_ut_fom_fop_fid; -``` +``` + **Makefile.am entry:** -``` +```C UT_SRCDIR = @SRCDIR@/reqh/ut noinst_LTLIBRARIES = libreqh-ut.la INCLUDES = -I. -I$(top_srcdir)/include \ -I$(top_srcdir) @@ -62,6 +63,7 @@ EXTRA_DIST = fom_io.ff MOSTLYCLEANFILES = $(FOM_FOPS) ``` + On compiling fom_io_xc.ff file using ff2c compiler, it creates corresponding fom_io_xc.h and fom_io_xc.c. ## Encoding-Decoding FOP diff --git a/doc/HLD-OF-Motr-LNet-Transport.md b/doc/HLD-OF-Motr-LNet-Transport.md index 86a7f989f39..345a1eb02f9 100644 --- a/doc/HLD-OF-Motr-LNet-Transport.md +++ b/doc/HLD-OF-Motr-LNet-Transport.md @@ -152,7 +152,7 @@ Support for this interface is transport specific and availability may also vary #### Controlling network buffer event delivery The design provides the following APIs for the higher level application to control when network buffer event delivery takes place and which thread is used for the buffer event callback. -``` +```C void m0_net_buffer_event_deliver_all(struct m0_net_transfer_mc *tm); int m0_net_buffer_event_deliver_synchronously(struct m0_net_transfer_mc *tm); bool m0_net_buffer_event_pending(struct m0_net_transfer_mc *tm); diff --git a/doc/HLD-of-Catalogue-Service.md b/doc/HLD-of-Catalogue-Service.md index bbdf3f29f80..c459a09979f 100644 --- a/doc/HLD-of-Catalogue-Service.md +++ b/doc/HLD-of-Catalogue-Service.md @@ -159,7 +159,7 @@ foreach key in req.input { | PUT | cfid, input: array of {key, val} | rc, count | :------------- | :------------- | :-------------| -``` +```C reply.count = 0; cat = catalogue_get(req.cfid); diff --git a/doc/Motr-Lnet-Transport.md b/doc/Motr-Lnet-Transport.md index 3abf474036b..94c849e7fa3 100644 --- a/doc/Motr-Lnet-Transport.md +++ b/doc/Motr-Lnet-Transport.md @@ -152,7 +152,7 @@ Support for this interface is transport specific and availability may also vary #### Controlling network buffer event delivery The design provides the following APIs for the higher level application to control when network buffer event delivery takes place and which thread is used for the buffer event callback. -``` +```C void m0_net_buffer_event_deliver_all(struct m0_net_transfer_mc *tm); int m0_net_buffer_event_deliver_synchronously(struct m0_net_transfer_mc *tm); bool m0_net_buffer_event_pending(struct m0_net_transfer_mc *tm); diff --git a/doc/Running_Motr_Across_a_Cluster.md b/doc/Running_Motr_Across_a_Cluster.md index a9bf2764fec..68e261dc7d4 100644 --- a/doc/Running_Motr_Across_a_Cluster.md +++ b/doc/Running_Motr_Across_a_Cluster.md @@ -18,14 +18,14 @@ This document provides information on how to build motr from source and then run 3. ### Configure your CDF ( cluster description file ) to "point" to all nodes in your cluster: 1. Create the CDF: - ```sh + ```yaml cp /opt/seagate/cortx/hare/share/cfgen/examples/singlenode.yaml ~/CDF.yaml vi ~/CDF.yaml ``` 2. Configure the CDF to "point" to each node in the cluster: 1. Add this text N-1 times, where N is the number of nodes to your CDF. The `ip a` will provide your available data_iface values, you must use the one that has `state UP`. Next, you can get the hostname for the node by running `cat /etc/hostname`. However, in some cases, the hostname might not be publicly recognizable by other nodes, so it's recommended to put an IP address instead of a hostname. - ```sh + ```yaml - hostname: ssu0 # [user@]hostname data_iface: ens33 # name of data network interface #data_iface_type: o2ib # type of network interface (optional); @@ -53,10 +53,11 @@ This document provides information on how to build motr from source and then run ``` > A single node CDF should look like this: - ```sh # Cluster Description File (CDF). # See `cfgen --help-schema` for the format description. nodes: + + ```yaml - hostname: ssu0 # [user@]hostname data_iface: ens33 # name of data network interface #data_iface_type: o2ib # type of network interface (optional); @@ -107,6 +108,8 @@ This document provides information on how to build motr from source and then run # Cluster Description File (CDF). # See `cfgen --help-schema` for the format description. nodes: + + ```yaml - hostname: ssu0 # [user@]hostname data_iface: ens33 # name of data network interface #data_iface_type: o2ib # type of network interface (optional); @@ -201,7 +204,7 @@ This document provides information on how to build motr from source and then run #profiles: # - name: default # pools: [ the pool ] - + ``` 4. ### Disable the firewall on each node: This is needed by s3 server, no need to do this if you don't have s3 client (`s3: 0`) on the CDF (at `m0_clients` section). diff --git a/doc/motr-object-app.md b/doc/motr-object-app.md index 3129d243e83..ef163afc42a 100644 --- a/doc/motr-object-app.md +++ b/doc/motr-object-app.md @@ -79,9 +79,8 @@ The most important and necessary configuration parameters: These parameters can be queried with one of the following options: -``` - `hctl status` will show these parameters -``` + If you've followed these instructions [Cluster Setup](https://github.com/Seagate/Cortx/blob/main/doc/Cluster_Setup.md) or [Quick Start Guide](/doc/Quick-Start-Guide.rst) to setup a Cortx Motr system. Or