Skip to content

Commit 001631b

Browse files
committed
fix readme
1 parent 6584c6b commit 001631b

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

.github/scripts/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ These rules can be found in the [HDL coding guidelines](https://analogdevicesinc
124124
It checks if the license header is up-to-date, containing the current year in
125125
the year range. Exceptions are the JESD files and the ones specified in the
126126
`avoid_list` string list.
127+
127128
If `-e` option is added, the script can update the year range.
128129

129130
#### 2. Empty lines
@@ -132,18 +133,21 @@ It checks if the file contains empty line issues:
132133
* Two or more consecutive empty lines.
133134
* An empty line at the beginning of the file.
134135
* An empty line at the end of the file.
135-
If the `-e` option is added, the script removes redundant empty lines and ensures
136+
137+
If `-e` option is added, the script removes redundant empty lines and ensures
136138
that at most one empty line is kept, while also removing any leading or trailing
137139
empty lines.
138140

139141
#### 3. Trailing whitespace
140142

141143
It checks if there are whitespace characters at the end of the lines.
144+
142145
If `-e` option is added, then they can be removed.
143146

144147
#### 4. Lines after end token
145148

146149
It checks if there are lines after end token (`endmodule` or `endpackage`).
150+
147151
If `-e` option is added, the script can remove them.
148152

149153
#### 5. Parentheses around the module declaration
@@ -152,6 +156,7 @@ It checks if the parentheses around the module declaration (meaning `) (` for
152156
the parameters' list) are on an empty line, right after the last parameter.
153157
It also checks for the closing parenthesis at the module declaration (meaning `);`)
154158
to be on an empty line, at the beginning, right after the last I/O port line.
159+
155160
If `-e` option is added, the script can put them in their proper place.
156161

157162
#### 6. Indentation of code
@@ -175,8 +180,8 @@ It checks if SystemVerilog packages are defined correctly:
175180
* `package <name>;` starts at column 0, with no extra spaces before or after ;.
176181
* `endpackage` is alone on its line at column 0.
177182
* Exactly one newline follows `endpackage`.
178-
* Inside the package, typedefs and localparams follow the same indentation and
179-
alignment rules.
183+
* Inside the package, typedefs and localparams follow the same indentation and alignment rules.
184+
180185
If the `-e` option is added, the script rewrites these to the guideline-compliant
181186
format.
182187

@@ -191,6 +196,7 @@ item has no comma.
191196
* Following elements are indented +2 spaces.
192197
* Inline comments are aligned at least 4 spaces after the longest element.
193198
* The closing `};` is attached to the last element.
199+
194200
If the `-e` option is added, the script normalizes the block automatically.
195201

196202
#### 10. Typedefs
@@ -201,6 +207,7 @@ It checks if typedef blocks are formatted correctly:
201207
* Inner items are indented +2.
202208
* Closing `} type_name;` is aligned with the opening `typedef`.
203209
* Inline comments after the closing are moved to a separate line.
210+
204211
If the `-e` option is added, the script rewrites the block to the guideline-compliant
205212
format.
206213

0 commit comments

Comments
 (0)