Skip to content

Commit 66e6d7e

Browse files
committed
Change the 'README.gnatcheck' file into 'README.md'
Also correct formatting of this file to comply with the MD format.
1 parent 8f6300e commit 66e6d7e

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed
Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
G N A T C H E C K E X A M P L E
2-
==================================
1+
GNATcheck Example
2+
=================
33

44
This directory contains a simple example of using GNATcheck. This example is
55
derived from one of the examples included in the GNAT compiler distribution
66
(see the subdirectory share/examples/gnat/simple_project of your compiler
77
installation if you have one).
88

9-
Compared to the original example, the following two things have been added:
9+
Compared to the original example, a sample GNATcheck coding standard file named
10+
`rules.lkql` has been added. This is an LKQL file containing a set of GNATcheck
11+
rules and their configuration.
1012

11-
- A sample GNATcheck coding standard file named 'rules.lkql'; this is an LKQL
12-
file containing a set of GNATcheck rules and their configuration.
13-
14-
If you want to try out GNATcheck on any other project - just copy the sample
15-
coding standard file to another project's directory, besides the GPR file.
13+
If you want to try out GNATcheck on any other project, simply copy the sample
14+
coding standard file to the project's directory, besides the GPR file.
1615
GNATcheck will use it by default when running on this project file.
1716

1817
You can also modify the coding standard file in any way you want - you can
@@ -26,12 +25,12 @@ Using GNATcheck from the command line
2625
$ gnatcheck -P simple.gpr
2726

2827
GNATcheck will output messages in your command shell, and will also generate
29-
the report file "gnatcheck/gnatcheck.out" in the project's objects directory.
28+
the report file `gnatcheck/gnatcheck.out` in the project's object directory.
3029

3130

3231
Using GNATcheck from GPS
3332
------------------------
3433

3534
Open the project file in GPS, then choose the command
36-
'Analyze->Coding Standard->Check Root Project". You will see the diagnoses
35+
`Analyze->Coding Standard->Check Root Project`. You will see the diagnoses
3736
generated by gnatcheck in the 'Locations' GPS window.

0 commit comments

Comments
 (0)