Skip to content

Commit

Permalink
doc/README.md:
Browse files Browse the repository at this point in the history
1. documents macho support
2. updated to 1.0 tc as per issue embench#112

doc/Makefile:
1. changed to sue en-US as dictionary as per issue embench#128
  • Loading branch information
Roger-Shepherd authored and PaoloS02 committed Apr 9, 2021
1 parent 64e14a5 commit 3228a96
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spell: README.md custom.wordlist
@sed < README.md -e 's/`[^`]\+`//g' -e '/^```/,/^```$$/d' \
-e 's/&#[^;]\+;//g' \
-e 's/<!-- .\+ -->//g' -e 's/\[.\+\]([^)]*)//g' | \
hunspell -p custom.wordlist -l -d en_US | sort -u
hunspell -p custom.wordlist -l -d en-US | sort -u

# PDF version of the documentation

Expand Down
19 changes: 12 additions & 7 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Document conventions:
-->

Authors: Embench&#x2122; Task Group
Issue: 0.5
Issue: 1.0

Copyright (C) 2009, 2013, 2019 Embecosm Limited

Expand Down Expand Up @@ -107,8 +107,8 @@ Embench is based on the following principles:

4. **Embench must have a supporting organization that maintains its
relevance over time:**
- need an organization to evolve suite over time;
- goal of refreshes every two years once we get to Embench 1.0; and
- need an organization to evolve the suite over time;
- goal of refreshes every two years; and
- set up inside an existing organization, the Free and Open Source Silicon
Foundation (FOSSi), rather than creating a new organization.

Expand Down Expand Up @@ -423,6 +423,8 @@ which takes the following arguments.
Benchmarking code size uses the [`benchmark_size.py`](../benchmark_size.py)
script, which takes the following arguments.
- `--format`: Specifies the file format of executable executable and/or object
files. The option are `elf` and `macho`. Default value `elf`.
- `--builddir`: The programs are build out of tree, this specifies the
directory in which the programs were built. It may be an absolute or
relative directory name; if the latter, it will be relative to the top level
Expand All @@ -441,17 +443,20 @@ script, which takes the following arguments.
specified, present absolute benchmark results. If neither is specified,
present relative results, because this is the defined norm for Embench.
- `--text`: A space separated list of sections containing code. Default value
`.text`.
for elf format files `.text`; for macho format files `__text`.
- `--data`: A space separated list of sections containing non-zero initialized
writable data. Default value `.data`.
writable data. Default value for elf format files `.data`; for macho format
files `__data`.
The option `--metric` with the respective section type needs to be used in
order to have the sections added to the size calculation.
- `--rodata`: A space separated list of sections containing read only data.
Default value `.rodata`.
Default value for elf format files `.rodata`; for macho format files
`__cstring __const`.
The option `--metric` with the respective section type needs to be used in
order to have the sections added to the size calculation.
- `--bss`: A space separated list of sections containing zero initialized
data. Default value `.bss`.
data. Default value for elf format files `.bss`, for macho format files
`__bss`.
The option `--metric` with the respective section type needs to be used in
order to have the sections added to the size calculation.
- `--metric`. A space separated list of section types to include when
Expand Down

0 comments on commit 3228a96

Please sign in to comment.