embench/embench-iot

Problems with documentation makefile/scripts

Closed this issue · 2 comments

Preparing to update the doc/README.doc to reflect the added support for macho I have some problems with the scripts/Makefiles in doc.

  1. Regarding spelling checking, the command line for hunspell is hunspell -p custom.wordlist -l -d en_US. I think the standard dictionary is en-US. With that fix
  2. The spelling checker throws out a lot of words. Should I add these to the custom.wordlist?
  3. make toc doesn't work for me. It produces a new version of README.md with the all the text prior to
    <!-- End of ToC insertion --> removed but no new toc. I don't know how to debug this.

The problem with make toc is that gentoc.sh assumes the use of gnu sed and uses some gnu specific extensions.

  1. \? which can be replaced by \{0,1\}
  2. 0,/regexp/ which can be replaced by 0,/regexp/ unless regexp matches the very first line of input. This should not be the case.

Solved with PR #132