<commit_before>This test is meant to be run manually; it is not part of "make check".

Someday I may figure out how to make this part of "make check", but
today is not that day.  :-)

You need to expand a distribution hwloc tarball in this directory and
rename the top-level directory from hwloc-<version>/ to hwloc-tree/.
Then run ./autogen.sh, ./configure, and make.  

The test is that:

 - autogen.sh runs properly and to completion
 - configure runs properly and to completion
 - make runs properly and to completion
 - you can run the resulting "./main" executable and it properly shows
   the hwloc depth of the current machine

If you look at configure.ac, you see that it uses the HWLOC m4 macros
to build the hwloc located at hwloc-tree/, and renames all the symbols
from "hwloc_<foo>" to "mytest_<foo>".  The main.c source calls several
hwloc functions via the "mytest_<foo>" symbols.  

Bottom line: if the "main" executable runs and prints the current
depth, the embedding should be working properly.<commit_msg>Update the README docs for the embedded tests. <commit_after>This test is meant to be run manually; it is not part of "make check".

Someday I may figure out how to make this part of "make check", but
today is not that day.  :-)

You can run these tests in one of two ways:

1. PREFERRED METHOD: From this directory, invoke
   "./run-embedded-tests.sh <path-to-hwloc-tarball>".  This will run a
   battery of tests against that tarball to verify that embedding is
   working properly from that tarball.

2. MANUAL METHOD: Expand a distribution hwloc tarball in this
   directory and rename the top-level directory from hwloc-<version>/
   to hwloc-tree/.  Then run ./autogen.sh, ./configure, and make.  And
   whatever other tests you'd like to run.

Things to test (most of which are done in the run-embedded-tests.sh
script):

 - autogen.sh runs properly and to completion
 - configure runs properly and to completion (normal, absolute VPATH,
   and relative VPATH)
 - make runs properly and to completion
 - you can run the resulting "./main" executable and it properly shows
   the hwloc depth of the current machine
 - make test works

If you look at configure.ac, you see that it uses the HWLOC m4 macros
to build the hwloc located at hwloc-tree/, and renames all the symbols
from "hwloc_<foo>" to "mytest_<foo>".  The main.c source calls several
hwloc functions via the "mytest_<foo>" symbols.

Bottom line: if the "main" executable runs and prints the current
depth (or you can run "make check" successfully), the embedding should
be working properly.
{'fraction_non_alphanumeric': 0.06462848297213622, 'fraction_numerical': 0.0015479876160990713, 'mean_word_length': 3.7518382352941178, 'pattern_counts': {'":': 0, '<': 12, '<?xml version=': 0, '>': 12, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '326749', 'n_tokens_mistral': 721, 'n_tokens_neox': 707, 'n_words': 396}