Skip to content

Commit f70a124

Browse files
authored
Make releasenotes display consistently
* Make releasenotes display consistently In particular, use prefix for the tracker-system, always a space before the bug-tag, as well as no dot before the tag but after - SIMICS-21408.
1 parent 02146c5 commit f70a124

File tree

3 files changed

+30
-29
lines changed

3 files changed

+30
-29
lines changed

RELEASENOTES-1.2.docu

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
<rn id="dml-1.2">
77
<name>Device Modeling Language (DML) 1.2</name>
88
<build-id value="6012"><add-note> Fixed a bug that caused a crash on the
9-
expression
10-
<tt>1 &lt;&lt; 64</tt> <bug number="1306575446"/>. </add-note></build-id>
9+
expression <tt>1 &lt;&lt; 64</tt>
10+
<bug number="HSD-1306575446"/>.</add-note></build-id>
1111
<build-id value="6018"><add-note> The <tt>read</tt> and <tt>write</tt>
1212
templates have been moved from
1313
utility.dml to always be included into 1.2 DML files. Additionally
@@ -23,7 +23,7 @@
2323
changed: If the path
2424
starts with <tt>./</tt>, the path is now interpreted relative to
2525
the directory of the importing file
26-
<bug number="2209506845"/>. </add-note></build-id>
26+
<bug number="HSD-2209506845"/>. </add-note></build-id>
2727
<build-id value="6024"><add-note> Fixed a bug that caused a bad warning and
2828
incorrect code when
2929
the operand to <tt>sizeof</tt> is an identifier that can be
@@ -49,7 +49,7 @@
4949
<build-id value="6031"><add-note> Fixed a bug in nested <tt>foreach</tt>
5050
loops when traversing
5151
register arrays inside bank arrays
52-
<bug number="1809370911"/>. </add-note></build-id>
52+
<bug number="HSD-1809370911"/>. </add-note></build-id>
5353
<build-id value="6036"><add-note> It is now permitted to use the
5454
<tt>nothrow</tt> annotation on a
5555
method override even if the overridden method does not. This is
@@ -96,30 +96,31 @@
9696
<build-id value="6054"><add-note>Fixed a crash on methods marked
9797
<tt>nothrow</tt> and
9898
multiple return arguments, returning a typed template or struct type
99-
<bug number="18012036595"/>. </add-note></build-id>
99+
<bug number="HSD-18012036595"/>. </add-note></build-id>
100100
<build-id value="6054"><add-note>The file <tt>dml12-compatibility.dml</tt>
101101
now adds a
102102
parameter <tt>val</tt> to <tt>field</tt> objects. </add-note></build-id>
103103
<build-id value="6059"><add-note>Unmapped registers names are now properly
104104
anonymized according
105105
to _confidentiality
106-
<bug number="1508117636"/>. </add-note></build-id>
106+
<bug number="HSD-1508117636"/>. </add-note></build-id>
107107
<build-id value="6066"><add-note> Fixed a regression in use cases where
108108
<tt>if</tt> has a
109109
constant condition, and the taken branch consists of a variable
110110
declaration. I.e., if the code <tt>if (true) local int x;</tt>
111111
appears in a scope, then the variable <tt>x</tt> is now added to
112-
that scope <bug number="18013028128"/>. </add-note></build-id>
112+
that scope <bug number="HSD-18013028128"/>. </add-note></build-id>
113113
<build-id value="6079"><add-note> If a <tt>static</tt> variable is
114114
declared within a method declared under an object array, it will
115115
now result in a separate instance of the variable for each
116-
instance of the containing object.
116+
instance of the containing object
117117
<bug number="SIMICS-13738"/>. </add-note></build-id>
118118
<build-id value="6082"><add-note> It is no longer possible to
119119
override the <tt>loggroup</tt> parameter inside a <tt>group</tt>
120120
object. </add-note></build-id>
121121
<build-id value="6082"><add-note> Added documentation of the <tt>nothrow</tt>
122-
annotation for methods <bug number="18012035545"/>. </add-note></build-id>
122+
annotation for methods
123+
<bug number="HSD-18012035545"/>. </add-note></build-id>
123124
<build-id value="6096"><add-note> Fixed a compile error when a DML
124125
1.2 device imports a DML 1.4 file that declares a <tt>saved</tt>
125126
variable inside a register or field
@@ -129,7 +130,7 @@
129130
<bug number="SIMICS-17308"/>. </add-note></build-id>
130131
<build-id value="6122"><add-note> Added the <tt>--state-change-dml12</tt>
131132
flag, allowing the use of an incomplete version of state change notifiers
132-
in DML 1.2 devices<bug number="SIMICS-17952"/>.</add-note></build-id>
133+
in DML 1.2 devices <bug number="SIMICS-17952"/>.</add-note></build-id>
133134
<build-id value="6124"><add-note> Fixed an issue when using the
134135
<tt>--state-change-dml12</tt> flag together with the
135136
<tt>--split-c-file</tt> flag

RELEASENOTES-1.4.docu

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
changed: If the path
5151
starts with <tt>./</tt> or <tt>../</tt>, the path is now
5252
interpreted relative to the directory of the importing file
53-
<bug number="2209506845"/>. </add-note></build-id>
53+
<bug number="HSD-2209506845"/>. </add-note></build-id>
5454
<build-id value="6024"><add-note> Fixed a problem where parameters defined in
5555
global scope in DML
5656
1.4 (typically auto-converted from a DML 1.2 <tt>constant</tt>)
@@ -89,7 +89,7 @@
8989
<build-id value="6046"><add-note> In <tt>switch</tt> statements,
9090
<tt>case</tt> labels are now
9191
permitted inside <tt>#if</tt> blocks
92-
<bug number="14011267833"/>. </add-note></build-id>
92+
<bug number="HSD-14011267833"/>. </add-note></build-id>
9393
<build-id value="6046"><add-note> Fixed an issue where the <tt>++</tt> and
9494
<tt>--</tt> operators could not
9595
be applied to pointers. </add-note></build-id>
@@ -163,17 +163,17 @@
163163
<build-id value="6079"><add-note> <tt>saved</tt> variable
164164
declarations are now available. These can be used to declare
165165
variables that behave similarly to <tt>session</tt> variables,
166-
but that are automatically checkpointed.
166+
but that are automatically checkpointed
167167
<bug number="SIMICS-7031"/>. </add-note></build-id>
168168
<build-id value="6079"><add-note> If a <tt>static</tt> variable is
169169
declared within a method declared under an object array, it will
170170
now result in a separate instance of the variable for each
171-
instance of the containing object.
171+
instance of the containing object
172172
<bug number="SIMICS-13738"/>. </add-note></build-id>
173173
<build-id value="6079"><add-note> Fixed a bug that caused a crash
174174
in <tt>print-device-regs</tt> and related commands, when
175175
inspecting a function-mapped bank array in a DML 1.4 device
176-
<bug number="1508646546"/>.</add-note></build-id>
176+
<bug number="HSD-1508646546"/>.</add-note></build-id>
177177
<build-id value="6080"><add-note> If a method argument has mismatching
178178
type in an override, then an error will now be
179179
reported <bug number="SIMICS-9337"/>.</add-note></build-id>
@@ -282,7 +282,7 @@
282282
</pre></add-note></build-id>
283283
<build-id value="6143"><add-note>Added an optimization that
284284
reduces the compile time for devices with huge register arrays
285-
<bug number="SIMICS-7038"/> </add-note></build-id>
285+
<bug number="SIMICS-7038"/>.</add-note></build-id>
286286
<build-id value="6143"><add-note> Added support for cancelling events posted
287287
via <tt>after</tt> statement through the use of the
288288
<tt>cancel_after()</tt> method, provided as part of the <tt>object</tt>
@@ -294,7 +294,7 @@
294294
<build-id value="6147"><add-note> When declaring an object array, any
295295
dimension size specification may now be omitted if already defined through
296296
a different declaration of the same object array
297-
<bug number="22014423596"/>. Omission is done by specifying <tt>...</tt>
297+
<bug number="HSD-22014423596"/>. Omission is done by specifying <tt>...</tt>
298298
instead of the dimension size; for example, the following is now
299299
supported:
300300
<pre>
@@ -368,7 +368,7 @@
368368
suppress logging.</add-note></build-id>
369369
<build-id value="6177"><add-note>Removed the generation of some
370370
broken <tt>#line</tt> directives that caused problems in code
371-
coverage reports <bug number="18024044100"/>.</add-note></build-id>
371+
coverage reports <bug number="HSD-18024044100"/>.</add-note></build-id>
372372
<build-id value="6177"><add-note>When using designated initializers, partial
373373
initialization is now possible through trailing <tt>...</tt> syntax
374374
<bug number="SIMICS-18705"/>. Members not explicitly initialized are
@@ -439,22 +439,22 @@
439439
<build-id value="6195"><add-note>Fixed Windows-specific gcc compile
440440
error on DMLC-generated code, caused by name clashes with
441441
the <tt>interface</tt> macro, defined by <tt>windows.h</tt>
442-
<bug number="15012582368"/>.</add-note></build-id>
442+
<bug number="HSD-15012582368"/>.</add-note></build-id>
443443
<build-id value="6200"><add-note>Fixed a bug in <tt>saved</tt>
444444
variables that caused stack overflow during checkpoint restore
445445
for huge (multi-megabyte) struct types
446-
<bug number="18026246959"/>.</add-note></build-id>
446+
<bug number="HSD-18026246959"/>.</add-note></build-id>
447447
<build-id value="6205"><add-note> <tt>--coverity</tt> has been added as an
448448
option to DMLC. When used, DMLC will generate Synopsys® Coverity® analysis
449449
annotations to suppress common false positives in generated C code created
450450
from DML 1.4 devices.</add-note></build-id>
451451
<build-id value="6205"><add-note> Fixed an ICE caused by constant inlined
452452
method parameters being used in constant equalities
453-
<bug number="16019548195"/>.</add-note></build-id>
453+
<bug number="HSD-16019548195"/>.</add-note></build-id>
454454
<build-id value="6205"><add-note> Fixed an issue with debuggable compilation
455455
(<tt>-g</tt>) that caused <tt>inline</tt> method calls to inline constant
456456
arguments even for parameters not declared <tt>inline</tt>
457-
<bug number="16019548195"/>.</add-note></build-id>
457+
<bug number="HSD-16019548195"/>.</add-note></build-id>
458458
<build-id value="6213"><add-note> Compound initializer syntax can now be used
459459
to construct arguments of a method or function call, e.g:
460460
<pre>

RELEASENOTES.docu

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1453,7 +1453,7 @@
14531453
<build-id value="6008"><add-note> In the <file>io-memory.dml</file> standard
14541454
library file,
14551455
the <fun>operation</fun> method is now marked <tt>default</tt>
1456-
<bug number="1507149841"/>. </add-note></build-id>
1456+
<bug number="HSD-1507149841"/>. </add-note></build-id>
14571457
<build-id value="6008"><add-note> A new parameter <tt>dml_1_2</tt> has been
14581458
added to device
14591459
scope. The parameter is true, but will be false in future
@@ -1472,7 +1472,7 @@
14721472
attribute <tt><v>bank</v>_<v>attr</v></tt> in the device upon
14731473
object creation. Previously, required attributes had to be set
14741474
directly on the bank object
1475-
<bug number="2207518293"/>. </add-note></build-id>
1475+
<bug number="HSD-2207518293"/>. </add-note></build-id>
14761476
<build-id value="6012"><add-note> Initial release of DML version 1.4. The new
14771477
language version is
14781478
documented in the <em>DML 1.4 reference manual</em>
@@ -1522,7 +1522,7 @@
15221522
<build-id value="6028"><add-note> Add support to <tt>header</tt> sections for
15231523
including a <tt>.h</tt>
15241524
file relative to the currently imported DML file
1525-
<bug number="2209645860"/>. </add-note></build-id>
1525+
<bug number="HSD-2209645860"/>. </add-note></build-id>
15261526
<build-id value="6030"><add-note> Fixed a bug where the
15271527
<tt>DMLDIR_<v>&lt;name&gt;</v>_H</tt> macro was
15281528
undefined when generating dependency files. </add-note></build-id>
@@ -1613,7 +1613,7 @@
16131613
parameter of the register or attribute. </add-note></build-id>
16141614
<build-id value="6075"><add-note> Fixed a bug that could cause a segmentation
16151615
fault when instantiating a device with register arrays following
1616-
certain patterns <bug number="1508585437"/>.</add-note></build-id>
1616+
certain patterns <bug number="HSD-1508585437"/>.</add-note></build-id>
16171617
<build-id value="6079"><add-note> If an array of <tt>connect</tt>
16181618
objects is declared
16191619
as <tt>configuration=optional</tt>, then it is now permitted to
@@ -1677,7 +1677,7 @@ extern typedef struct { } my_type_t;</pre> </add-note></build-id>
16771677
path. </add-note></build-id>
16781678
<build-id value="6132"><add-note> Fixed a problem with `log error`
16791679
statements when there are more than 32 log groups
1680-
<bug number="1305472692"/>. </add-note></build-id>
1680+
<bug number="HSD-1305472692"/>. </add-note></build-id>
16811681
<build-id value="6132"><add-note> Unicode BiDi control characters
16821682
are no longer permitted in DML source files, for security
16831683
reasons. </add-note></build-id>
@@ -1698,7 +1698,7 @@ extern typedef struct { } my_type_t;</pre> </add-note></build-id>
16981698
</pre></add-note></build-id>
16991699
<build-id value="6141"><add-note> <tt>break</tt> may now be used within
17001700
<tt>foreach</tt> statements in DML 1.2 and <tt>#foreach</tt> statements in
1701-
DML 1.4 <bug number="1309451301"/>.
1701+
DML 1.4 <bug number="HSD-1309451301"/>.
17021702
</add-note></build-id>
17031703
<build-id value="6143"><add-note> (Partially) const-qualified <tt>session</tt>
17041704
variables no longer result in invalid generated C
@@ -1726,7 +1726,7 @@ extern typedef struct { } my_type_t;</pre> </add-note></build-id>
17261726
</add-note></build-id>
17271727
<build-id value="6247"><add-note> Added a warning for if a specified log
17281728
level of a log statement is likely intended to instead specify the log
1729-
groups, and/or vice versa <bug number="22018374443"/>.
1729+
groups, and/or vice versa <bug number="HSD-22018374443"/>.
17301730
This warning is only enabled by default with Simics API version 7 or
17311731
above. With version 6 and below it must be explicitly enabled by passing
17321732
<tt>--warn=WLOGMIXUP</tt> to DMLC.</add-note></build-id>

0 commit comments

Comments
 (0)