Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Commit

Permalink
CORTX-33978: codacy cleanup: Fixed formatting issues (#2087)
Browse files Browse the repository at this point in the history
[fenced-code-flag] -> added name of programming language after 3 backquotes ```

Signed-off-by: Pratik Patil <pratik.k.patil@seagate.com>
  • Loading branch information
pratik-patil-5611 authored Aug 18, 2022
1 parent de245d3 commit 9935bf1
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 11 deletions.
6 changes: 4 additions & 2 deletions doc/FOPFOM-Programming-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/HLD-OF-Motr-LNet-Transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion doc/HLD-of-Catalogue-Service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion doc/Motr-Lnet-Transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
11 changes: 7 additions & 4 deletions doc/Running_Motr_Across_a_Cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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).
Expand Down
3 changes: 1 addition & 2 deletions doc/motr-object-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9935bf1

Please sign in to comment.