Skip to content

Commit e1905c4

Browse files
committed
Be more careful with markdown notation
1 parent 44d1e16 commit e1905c4

File tree

8 files changed

+135
-144
lines changed

8 files changed

+135
-144
lines changed

README.md

+110-119
Large diffs are not rendered by default.

Some_acpphint_curves_with_notes.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
##### Some_acpphint_curves_with_notes.md
1+
##### Some\_acpphint\_curves\_with\_notes.md
22
This covers:
33

44
0. Cortex-A57 cores with and without smaller cache level(s) being shared
@@ -36,7 +36,7 @@ Effects of competing for the shared RAM cache level(s) can be seen:
3636
(left side of goldenrod vs. blue curves)
3737
1. Computing is somewhat slower.
3838
(right side of goldenrod vs. blue curves)
39-
2. The curve structures show a RAM cache changes at around n*256 KiByte, for n
39+
2. The curve structures show a RAM cache changes at around n\*256 KiByte, for n
4040
being the number of hardware threads in use.
4141
3. The curve structures show a RAM cache change at about 8 MiByte.
4242
4. The 1-hardware-thread curves show a RAM cache change at about 32 KiByte.
@@ -116,7 +116,7 @@ Notes:
116116
0. The x and y ranges for all the plots for 1950X CCD/CCX 2/4 thread
117117
combinations are the same, making comparison/contrast easier.
118118
1. The curves for allowing (hardware) thread migration without SMT involvement
119-
show very clear evidence of around n*512 KiByte and 16 MiByte RAM cache
119+
show very clear evidence of around n\*512 KiByte and 16 MiByte RAM cache
120120
changes, n being the number of (hardware) threads.
121121
2. The shared smaller cache level(s) for SMT usage have competing usage and make
122122
them show messier transitions.
@@ -154,7 +154,7 @@ Notes:
154154
0. The x and y ranges for all the plots for 1950X CCD/CCX 2/4 thread
155155
combinations are the same, making comparison/contrast easier.
156156
1. The curves for allowing (hardware) thread migration without SMT involvement
157-
show very clear evidence of around n*512 KiByte, 16 MiByte, and 32 MiByte RAM
157+
show very clear evidence of around n\*512 KiByte, 16 MiByte, and 32 MiByte RAM
158158
cache changes, n being the number of (hardware) threads, except for the 2CCD 4CCX case that has more cache per (hardware) thread.
159159
2. The shared smaller cache level(s) for SMT usage have competing usage and make
160160
them show messier transitions.

acpphint_example_data/LICENSE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##### acpphint_example_data/LICENSE.md
1+
##### acpphint\_example\_data/LICENSE.md
22

3-
###### Licensing for generated-data-files, `.gp` files, and plot images (.png) . . .
3+
###### Licensing for generated-data-files, `.gp` files, and plot images (\*.png) . . .
44
There is no intent for any of the generated data files, the example `.gp` files
55
for use with gnuplot, or the plot images to have any licensing restrictions,
66
unlike, for example, the C++ source code and the associated binary files.

acpphint_example_data/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### acpphint_example_data/README.md
1+
#### acpphint\_example\_data/README.md
22
In general these notes are as of when they were written.
33

44
This covers:
@@ -32,8 +32,8 @@ WDK23_CA72-FBSD/
3232
WDK23_CA78C-FBSD/
3333
```
3434
(I do not distribute binaries. But I also do not distribute the
35-
source sys_cpubinding_lgplv2_1_okay.cpp that I used to prove
36-
that a Linux was supportable for WANT_CPU_LOCKDOWN builds.
35+
source sys\_cpubinding\_lgplv2\_1\_okay.cpp that I used to prove
36+
that a Linux was supportable for WANT\_CPU\_LOCKDOWN builds.
3737
I just wanted to avoid covering yet more licensing criteria.)
3838

3939
`acpphint_example_data/` also contains some `*.gp`
@@ -76,7 +76,7 @@ The fields are:
7676
1. median trial's mean time per lap in sec
7777
(median from sort by mean time per lap)
7878
2. QUality ImProvement/sec (a.k.a QUIPS)
79-
3. Quality (a.k.a QUIPS * previously listed time per lap,
79+
3. Quality (a.k.a QUIPS \* previously listed time per lap,
8080
like in the original pthread HINT)
8181
4. kernel vectors total memory use
8282

acpphint_src/Code_issues_vs_original_HINTs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### acpphint_src/Code_issues_vs_original_HINTs.md
1+
#### acpphint\_src/Code\_issues\_vs\_original\_HINTs.md
22
This file documents properties of source code
33
differences with the original serial and
44
pthreads HINT benchmarks.
@@ -27,7 +27,7 @@ For this variation on HINT, RUNTM is computed instead
2727
of being directly adjustable. PATIENCE, MXPROC, DSREFS,
2828
ISREFS, and MSIZE are not used.
2929

30-
For this variation on HINT, STILL_UNKNOWN was
30+
For this variation on HINT, STILL\_UNKNOWN was
3131
added to EFlag as the first value.
3232

3333
The original serial and pthread HINTs did not use
@@ -58,7 +58,7 @@ for readability):
5858
* sizeof(ISIZE) * 2));
5959
```
6060
but it later miscalculated the memory use for those (missing
61-
any '*2' or tracking of the largest index actually used
61+
any '\*2' or tracking of the largest index actually used
6262
in errs and in ixes):
6363
```
6464
memuse = (int)(qdata[i-1].n
@@ -168,7 +168,7 @@ That is a problem vs the description of MXPROC: "Maximum
168168
number of processors to use in shared memory configuration".
169169
With each "processor" having HI and LO entries in gs the
170170
maximum "processor" count is MXPROC/2 in order to avoid
171-
trashing memory and accessing unowned memory. "2*" could be
171+
trashing memory and accessing unowned memory. "2\*" could be
172172
considered as missing from the gs declaration. Or the hint.h
173173
description could be considered wrong.
174174

@@ -275,7 +275,7 @@ initialization was very different: It was based on setting up
275275
the scatter decomposition.
276276

277277
At no stage was there an explicit single cell spanning the whole
278-
scx*scy area so no individual area calculation spanned a big
278+
scx\*scy area so no individual area calculation spanned a big
279279
enough area to have overflow/truncation/rounding issues. Nor did
280280
any sum of areas that was peformed.
281281

acpphint_src/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### acpphint_src/README.md
1+
#### acpphint\_src/README.md
22
This covers:
33
1. What `acpphint` is a variation on . . .
44
2. How to build . . .
@@ -133,7 +133,7 @@ say to make builds take less time.
133133

134134
The default currently is to build ul (unsigned long) and which ever of ull
135135
(unsigned long long) or ui (unsigned int) that have the same maximum value
136-
as unsigned long. There is a macro DSIZE_ALL_ISIZE_ALL that, when defined,
136+
as unsigned long. There is a macro DSIZE\_ALL\_ISIZE\_ALL that, when defined,
137137
leads to a wide variety of DSIZE ISIZE combinations in most of the programs.
138138

139139
`acpphint_kernels.cpp` has, for example (abbreviated/line-split),
@@ -248,7 +248,7 @@ See `../*.md` for more overall information.
248248
Overall, each `acpphint*-NAME` is licensed as GPLv2 (not earlier, not later).
249249
But building the acpphint related code does build some OpenBSD-vintage-ISC
250250
licensed source files, those under `other_src_used/` instead of under
251-
`acpphint_src/`. Some resulting object files are linked into the acpphint*-NAME
251+
`acpphint_src/`. Some resulting object files are linked into the acpphint\*-NAME
252252
related programs.
253253

254254
See the `acpphint_src/LICENSE.md` for the GPLv2 license text that applies to the
@@ -257,7 +257,7 @@ Programs that do not have names that start with `acpphint` do not contain code
257257
from `acpphint_src/` ( just from `../other_src_used/` ).
258258

259259
See the `../other_src_used/LICENSE.md` for the OpenBSD-vintage-ISC license text
260-
that applies to just the source files in other_src_used/ and to any binaries not
260+
that applies to just the source files in other\_src\_used/ and to any binaries not
261261
containing code from `acpphint_src/` source files.
262262

263263
Note: The original HINT's copyright holder, Iowa State University Research

acpphint_src/Usage_differences_with_original_HINTs.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#### acpphint_src/Usage_differences_with_original_HINTs.md
1+
#### acpphint\_src/Usage\_differences\_with\_original\_HINTs.md
22
This file documents differences with the original serial and
33
pthreads HINT benchmarks that matter for use.
44

@@ -23,7 +23,7 @@ format appropriate for at least gnuplot):
2323
1. median trail's mean time per lap in sec
2424
(median from sort by mean time per lap)
2525
2. QUality ImProvement/sec (a.k.a QUIPS)
26-
3. Quality (a.k.a QUIPS * previously listed time per lap,
26+
3. Quality (a.k.a QUIPS \* previously listed time per lap,
2727
like in the original pthread HINT)
2828
4. kernel vectors total memory use
2929
(not an understated figure like the original
@@ -51,7 +51,7 @@ HINT counts.
5151
##### argv[?] use . . .
5252
The output files have the argv[0] text as the file name
5353
prefix and text after that identifying the specific test.
54-
The example makefile.* files generate very long command
54+
The example makefile.\* files generate very long command
5555
names that encode lots of context information.
5656

5757
The default filename suffix is ".txt" .
@@ -124,7 +124,7 @@ for readability):
124124
* sizeof(ISIZE) * 2));
125125
```
126126
but later miscalculated the memory use for those (missing any
127-
'*2'):
127+
\*2):
128128
```
129129
memuse = (int)(qdata[i-1].n
130130
* (sizeof(RECT)+sizeof(DSIZE)+sizeof(ISIZE)));

other_src_used/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
#### other_src_used/README.md
1+
#### other\_src\_used/README.md
22
`acpphint` is a variation on the original HINT benchmark, but written in C++ and with various choices specific to my use.
33

4-
While, overall, `acpphint` is licensed as GPLv2 (not earlier, not later), building the `acpphint` related code does build some OpenBSD-vintage-ISC licensed source files, these are under `other_src_used/` . Some of these object files are linked into the acpphint related programs. There is one program (cpp_clock_info_main) which only uses `other_src_used/` source code (including itself). The ISC licensed source code and these object files are not derivatives of the original HINT benchmark code and have other potential uses.
4+
While, overall, `acpphint` is licensed as GPLv2 (not earlier, not later), building the `acpphint` related code does build some OpenBSD-vintage-ISC licensed source files, these are under `other_src_used/` . Some of these object files are linked into the acpphint related programs. There is one program (cpp\_clock\_info\_main) which only uses `other_src_used/` source code (including itself). The ISC licensed source code and these object files are not derivatives of the original HINT benchmark code and have other potential uses.
55

66
See the `other_src_used/LICENSE.md` for the OpenBSD-vintage-ISC license text that applies to just the source files in `other_src_used/` . Each distributed `other_src_used/` C++ source file also contains the OpenBSD-vintage-ISC license text.
77

0 commit comments

Comments
 (0)