@@ -21,7 +21,7 @@ Subcommands
21
21
* :ref: `yaml2bitstream_subcommand ` - Reserialize YAML remarks to bitstream.
22
22
* :ref: `instruction-count_subcommand ` - Output function instruction counts.
23
23
* :ref: `annotation-count_subcommand ` - Output remark type count from annotation remarks.
24
- * :ref: `size-diff_subcommand ` - Compute diff in size remarks.
24
+ * :ref: `size-diff_subcommand ` - Compute diff in size remarks.
25
25
26
26
.. _bitstream2yaml_subcommand :
27
27
@@ -171,7 +171,7 @@ two sections:
171
171
* A high-level summary of all changes.
172
172
173
173
Changed Function Section
174
- ########################
174
+ ~~~~~~~~~~~~~~~~~~~~~~~~
175
175
176
176
Suppose you are comparing two remark files OLD and NEW.
177
177
@@ -208,7 +208,7 @@ A breakdown of the format is below:
208
208
Second file stack byte count - first file stack byte count.
209
209
210
210
Summary Section
211
- ###############
211
+ ~~~~~~~~~~~~~~~
212
212
213
213
:program: `llvm-remarkutil size-diff ` will output a high-level summary after
214
214
printing all changed functions.
@@ -236,7 +236,7 @@ JSON OUTPUT
236
236
-----------
237
237
238
238
High-Level view
239
- ###############
239
+ ~~~~~~~~~~~~~~~
240
240
241
241
Suppose we are comparing two files, OLD and NEW.
242
242
@@ -278,7 +278,7 @@ Suppose we are comparing two files, OLD and NEW.
278
278
Functions only present in the second file.
279
279
280
280
Function JSON
281
- #############
281
+ ~~~~~~~~~~~~~
282
282
283
283
The ``InBoth ``, ``OnlyInA ``, and ``OnlyInB `` sections contain size information
284
284
for each function in the input remark files.
@@ -313,7 +313,7 @@ for each function in the input remark files.
313
313
* ``STACK_BYTES_B ``: Stack bytes in NEW.
314
314
315
315
Computing Diffs From Function JSON
316
- **********************************
316
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317
317
318
318
Function JSON does not contain the diffs. Tools consuming JSON output from
319
319
:program: `llvm-remarkutil size-diff ` are responsible for computing the diffs
0 commit comments