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

Commit 15ce008

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

File tree

9 files changed

+14
-12
lines changed

9 files changed

+14
-12
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/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

scripts/provisioning/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ which is more convenient:
333333
```
334334

335335
The `m0vg` helper script is a wrapper around _Vagrant_ and _Ansible_ commands
336-
that can be *symlinked* somewhere into the `PATH` and be called from any
336+
that can be **symlinked** somewhere into the `PATH` and be called from any
337337
directory. Check out `m0vg --help` for more info.
338338

339339
It will spawn a VM and configure it using _Ansible_ "playbook"
@@ -354,7 +354,9 @@ below for the list of other useful _Vagrant_ commands.
354354
355355
If a cluster-like environment is needed, more machines can be provisioned:
356356
357-
./scripts/m0vg up cmu /ssu/ /client/
357+
```sh
358+
./scripts/m0vg up cmu /ssu/ /client/
359+
```
358360
359361
The additional parameters are also explained in the _Vagrant basics_ section
360362
below.

0 commit comments

Comments
 (0)