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

Commit cd23bbf

Browse files
author
Rohan Dhodare
committed
CORTX-33702: Codacy cleanup of markdown files
Signed-off-by: Rohan Dhodare <[email protected]>
1 parent d7da706 commit cd23bbf

10 files changed

+153
-155
lines changed

‎doc/FOPFOM-Programming-Guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A .ff file should be compiled using ff2c compiler.
3838
After writing FOPs and creating .ff file for a particular module, we need to make an entry for the same in the module's Makefile.am file. This would automatically invoke ff2c on the .ff files and create corresponding “C” format structures.
3939

4040
** A FOP, containing native data types in file fom_io_xc.ff:**
41-
```
41+
```C
4242
record {
4343
u64 f_seq;
4444
u64 f_oid

‎doc/HLD-OF-Motr-LNet-Transport.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ See Support for multiple message delivery in a single network buffer.
140140

141141
The design provides an API for the higher level application to associate the internal threads used by a transfer machine with a set of processors. In particular the API guarantees that buffer and transfer machine callbacks will be made only on the processors specified.
142142

143-
```
143+
```C
144144
#include “lib/processor.h”
145145

146146
...

‎doc/HLD-of-Catalogue-Service.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Deathrow catalogue contains all large catalogues which are in the process of bei
147147
148148
GET cfid, input: array of {key rc, output: array of {exists, val}
149149
150-
```
150+
```C
151151
cat = catalogue_get(req.cfid);
152152
153153
foreach key in req.input {

‎doc/Motr-Epochs-HLD.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ EpochTransitionRequest { service :: ServiceId
7474
, targetEpoch :: EpochId }
7575
```
7676
HA services that wrap Motr services must be able to accept the following additional messages:
77-
```
77+
```Text
7878
EpochTransition { targetEpoch :: EpochId
7979
8080
, epochTransitionPayload :: a }

‎doc/Motr-Lnet-Transport.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ See Support for multiple message delivery in a single network buffer.
140140

141141
The design provides an API for the higher level application to associate the internal threads used by a transfer machine with a set of processors. In particular the API guarantees that buffer and transfer machine callbacks will be made only on the processors specified.
142142

143-
```
143+
```C
144144
#include “lib/processor.h”
145145

146146
...

‎doc/Running_Motr_Across_a_Cluster.md‎

Lines changed: 139 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This document provides information on how to build motr from source and then run
2525

2626
2. Configure the CDF to "point" to each node in the cluster:
2727
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.
28-
```sh
28+
```yml
2929
- hostname: ssu0 # [user@]hostname
3030
data_iface: ens33 # name of data network interface
3131
#data_iface_type: o2ib # type of network interface (optional);
@@ -52,157 +52,153 @@ This document provides information on how to build motr from source and then run
5252
other: 2 # max quantity of other Motr clients this host may have
5353
```
5454
> A single node CDF should look like this:
55-
56-
```sh
55+
```yml
5756
# Cluster Description File (CDF).
5857
# See `cfgen --help-schema` for the format description.
5958
nodes:
60-
- hostname: ssu0 # [user@]hostname
61-
data_iface: ens33 # name of data network interface
62-
#data_iface_type: o2ib # type of network interface (optional);
63-
# supported values: "tcp" (default), "o2ib"
64-
m0_servers:
65-
- runs_confd: true
66-
io_disks:
67-
data: []
68-
- io_disks:
69-
#meta_data: /path/to/meta-data/drive
70-
data:
71-
- /dev/loop0
72-
- /dev/loop1
73-
- /dev/loop2
74-
- /dev/loop3
75-
- /dev/loop4
76-
- /dev/loop5
77-
- /dev/loop6
78-
- /dev/loop7
79-
- /dev/loop8
80-
- /dev/loop9
81-
m0_clients:
82-
s3: 0 # number of S3 servers to start
83-
other: 2 # max quantity of other Motr clients this host may have
84-
pools:
85-
- name: the pool
86-
#type: sns # optional; supported values: "sns" (default), "dix", "md"
87-
#disk_refs:
88-
# - { path: /dev/loop0, node: localhost }
89-
# - path: /dev/loop1
90-
# - path: /dev/loop2
91-
# - path: /dev/loop3
92-
# - path: /dev/loop4
93-
# - path: /dev/loop5
94-
# - path: /dev/loop6
95-
# - path: /dev/loop7
96-
# - path: /dev/loop8
97-
# - path: /dev/loop9
98-
data_units: 1
99-
parity_units: 0
100-
#allowed_failures: { site: 0, rack: 0, encl: 0, ctrl: 0, disk: 0 }
101-
#profiles:
102-
# - name: default
103-
# pools: [ the pool ]
104-
```
59+
- hostname: ssu0 # [user@]hostname
60+
data_iface: ens33 # name of data network interface
61+
#data_iface_type: o2ib # type of network interface (optional);
62+
# supported values: "tcp" (default), "o2ib"
63+
m0_servers:
64+
- runs_confd: true
65+
io_disks:
66+
data: []
67+
- io_disks:
68+
#meta_data: /path/to/meta-data/drive
69+
data:
70+
- /dev/loop0
71+
- /dev/loop1
72+
- /dev/loop2
73+
- /dev/loop3
74+
- /dev/loop4
75+
- /dev/loop5
76+
- /dev/loop6
77+
- /dev/loop7
78+
- /dev/loop8
79+
- /dev/loop9
80+
m0_clients:
81+
s3: 0 # number of S3 servers to start
82+
other: 2 # max quantity of other Motr clients this host may have
83+
pools:
84+
- name: the pool
85+
#type: sns # optional; supported values: "sns" (default), "dix", "md"
86+
#disk_refs:
87+
# - { path: /dev/loop0, node: localhost }
88+
# - path: /dev/loop1
89+
# - path: /dev/loop2
90+
# - path: /dev/loop3
91+
# - path: /dev/loop4
92+
# - path: /dev/loop5
93+
# - path: /dev/loop6
94+
# - path: /dev/loop7
95+
# - path: /dev/loop8
96+
# - path: /dev/loop9
97+
data_units: 1
98+
parity_units: 0
99+
#allowed_failures: { site: 0, rack: 0, encl: 0, ctrl: 0, disk: 0 }
100+
#profiles:
101+
# - name: default
102+
# pools: [ the pool ]
103+
```
105104
> Whereas a CDF with 3 nodes should look like this:
106-
105+
```yml
107106
# Cluster Description File (CDF).
108107
# See `cfgen --help-schema` for the format description.
109108
nodes:
110-
- hostname: ssu0 # [user@]hostname
111-
data_iface: ens33 # name of data network interface
112-
#data_iface_type: o2ib # type of network interface (optional);
113-
# supported values: "tcp" (default), "o2ib"
114-
m0_servers:
115-
- runs_confd: true
116-
io_disks:
117-
data: []
118-
- io_disks:
119-
#meta_data: /path/to/meta-data/drive
120-
data:
121-
- /dev/loop0
122-
- /dev/loop1
123-
- /dev/loop2
124-
- /dev/loop3
125-
- /dev/loop4
126-
- /dev/loop5
127-
- /dev/loop6
128-
- /dev/loop7
129-
- /dev/loop8
130-
- /dev/loop9
131-
m0_clients:
132-
s3: 0 # number of S3 servers to start
133-
other: 2 # max quantity of other Motr clients this host may have
134-
109+
- hostname: ssu0 # [user@]hostname
110+
data_iface: ens33 # name of data network interface
111+
#data_iface_type: o2ib # type of network interface (optional);
112+
# supported values: "tcp" (default), "o2ib"
113+
m0_servers:
114+
- runs_confd: true
115+
io_disks:
116+
data: []
117+
- io_disks:
118+
#meta_data: /path/to/meta-data/drive
119+
data:
120+
- /dev/loop0
121+
- /dev/loop1
122+
- /dev/loop2
123+
- /dev/loop3
124+
- /dev/loop4
125+
- /dev/loop5
126+
- /dev/loop6
127+
- /dev/loop7
128+
- /dev/loop8
129+
- /dev/loop9
130+
m0_clients:
131+
s3: 0 # number of S3 servers to start
132+
other: 2 # max quantity of other Motr clients this host may have
135133
- hostname: ssu1 # [user@]hostname
136-
data_iface: ens33 # name of data network interface
137-
#data_iface_type: o2ib # type of network interface (optional);
138-
# supported values: "tcp" (default), "o2ib"
139-
m0_servers:
140-
- runs_confd: true
141-
io_disks:
142-
data: []
143-
- io_disks:
144-
#meta_data: /path/to/meta-data/drive
145-
data:
146-
- /dev/loop0
147-
- /dev/loop1
148-
- /dev/loop2
149-
- /dev/loop3
150-
- /dev/loop4
151-
- /dev/loop5
152-
- /dev/loop6
153-
- /dev/loop7
154-
- /dev/loop8
155-
- /dev/loop9
156-
m0_clients:
157-
s3: 0 # number of S3 servers to start
158-
other: 2 # max quantity of other Motr clients this host may have
159-
134+
data_iface: ens33 # name of data network interface
135+
#data_iface_type: o2ib # type of network interface (optional);
136+
# supported values: "tcp" (default), "o2ib"
137+
m0_servers:
138+
- runs_confd: true
139+
io_disks:
140+
data: []
141+
- io_disks:
142+
#meta_data: /path/to/meta-data/drive
143+
data:
144+
- /dev/loop0
145+
- /dev/loop1
146+
- /dev/loop2
147+
- /dev/loop3
148+
- /dev/loop4
149+
- /dev/loop5
150+
- /dev/loop6
151+
- /dev/loop7
152+
- /dev/loop8
153+
- /dev/loop9
154+
m0_clients:
155+
s3: 0 # number of S3 servers to start
156+
other: 2 # max quantity of other Motr clients this host may have
160157
- hostname: ssu2 # [user@]hostname
161-
data_iface: ens33 # name of data network interface
162-
#data_iface_type: o2ib # type of network interface (optional);
163-
# supported values: "tcp" (default), "o2ib"
164-
m0_servers:
165-
- runs_confd: true
166-
io_disks:
167-
data: []
168-
- io_disks:
169-
#meta_data: /path/to/meta-data/drive
170-
data:
171-
- /dev/loop0
172-
- /dev/loop1
173-
- /dev/loop2
174-
- /dev/loop3
175-
- /dev/loop4
176-
- /dev/loop5
177-
- /dev/loop6
178-
- /dev/loop7
179-
- /dev/loop8
180-
- /dev/loop9
181-
m0_clients:
182-
s3: 0 # number of S3 servers to start
183-
other: 2 # max quantity of other Motr clients this host may have
184-
pools:
185-
- name: the pool
186-
#type: sns # optional; supported values: "sns" (default), "dix", "md"
187-
#disk_refs:
188-
# - { path: /dev/loop0, node: localhost }
189-
# - path: /dev/loop1
190-
# - path: /dev/loop2
191-
# - path: /dev/loop3
192-
# - path: /dev/loop4
193-
# - path: /dev/loop5
194-
# - path: /dev/loop6
195-
# - path: /dev/loop7
196-
# - path: /dev/loop8
197-
# - path: /dev/loop9
198-
data_units: 1
199-
parity_units: 0
200-
#allowed_failures: { site: 0, rack: 0, encl: 0, ctrl: 0, disk: 0 }
201-
#profiles:
202-
# - name: default
203-
# pools: [ the pool ]
204-
205-
158+
data_iface: ens33 # name of data network interface
159+
#data_iface_type: o2ib # type of network interface (optional);
160+
# supported values: "tcp" (default), "o2ib"
161+
m0_servers:
162+
- runs_confd: true
163+
io_disks:
164+
data: []
165+
- io_disks:
166+
#meta_data: /path/to/meta-data/drive
167+
data:
168+
- /dev/loop0
169+
- /dev/loop1
170+
- /dev/loop2
171+
- /dev/loop3
172+
- /dev/loop4
173+
- /dev/loop5
174+
- /dev/loop6
175+
- /dev/loop7
176+
- /dev/loop8
177+
- /dev/loop9
178+
m0_clients:
179+
s3: 0 # number of S3 servers to start
180+
other: 2 # max quantity of other Motr clients this host may have
181+
pools:
182+
- name: the pool
183+
#type: sns # optional; supported values: "sns" (default), "dix", "md"
184+
#disk_refs:
185+
# - { path: /dev/loop0, node: localhost }
186+
# - path: /dev/loop1
187+
# - path: /dev/loop2
188+
# - path: /dev/loop3
189+
# - path: /dev/loop4
190+
# - path: /dev/loop5
191+
# - path: /dev/loop6
192+
# - path: /dev/loop7
193+
# - path: /dev/loop8
194+
# - path: /dev/loop9
195+
data_units: 1
196+
parity_units: 0
197+
#allowed_failures: { site: 0, rack: 0, encl: 0, ctrl: 0, disk: 0 }
198+
#profiles:
199+
# - name: default
200+
# pools: [ the pool ]
201+
```
206202
4. ### Disable the firewall on each node:
207203
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).
208204
```sh

‎doc/Seagate-FDMI-HLD.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ the data to plug-in instance.
121121

122122
Successful data processing results in returning acknowledge along with confirmation allowing data release, if required.
123123

124-
### 1.9.3 De-initialization
124+
### 1.9.3 De-initialization ###
125125
![image](./images/Image4_sequenceDiagram.PNG)
126126

127127
Plug-in initiates de-initialization by calling local FDMI. The latter deregisters plug-in’s filter set with filtered service. After

‎doc/motr-kv-app.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Init the m0\_idx struct with m0\_idx\_init().
1717
1818
Init the index create operation with m0\_entity\_create().
1919
20-
```
20+
`
2121
An ID is needed for this index. In this example, ID is configured from command line.
2222
Developers are responsible to generate an unique ID for their indices.
23-
```
23+
`
2424
2525
Launch the operation with m0\_op\_launch().
2626

‎doc/motr-object-app.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Motr applications. Please refer to source code "lib/"
3131

3232
Define necessary variables (global or in main() function)
3333

34-
```
34+
```C
3535
static struct m0_client *m0_instance = NULL;
3636
static struct m0_container motr_container;
3737
static struct m0_config motr_conf;
@@ -40,7 +40,7 @@ Define necessary variables (global or in main() function)
4040

4141
Get configuration arguments from command line
4242

43-
```
43+
```C
4444

4545
#include "motr/client.h"
4646

0 commit comments

Comments
 (0)