File tree Expand file tree Collapse file tree 2 files changed +21
-2
lines changed Expand file tree Collapse file tree 2 files changed +21
-2
lines changed Original file line number Diff line number Diff line change @@ -733,7 +733,7 @@ WARN_LOGFILE =
733
733
# spaces.
734
734
# Note: If this tag is empty the current directory is searched.
735
735
736
- INPUT = src
736
+ INPUT = docs/main.md src
737
737
738
738
# This tag can be used to specify the character encoding of the source files
739
739
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -869,7 +869,7 @@ FILTER_SOURCE_PATTERNS =
869
869
# (index.html). This can be useful if you have a project on for instance GitHub
870
870
# and want to reuse the introduction page also for the doxygen output.
871
871
872
- USE_MDFILE_AS_MAINPAGE =
872
+ USE_MDFILE_AS_MAINPAGE = docs/main.md
873
873
874
874
#---------------------------------------------------------------------------
875
875
# Configuration options related to source browsing
Original file line number Diff line number Diff line change
1
+ sotoc - Source Transformation for OpenMP Code (suggestions for a better name are greatly appreciated) {#mainpage}
2
+ =====================================================================================================
3
+
4
+ ` sotoc ` is written as a Clang tool and makes use of the Clang tooling
5
+ infrastructure to parse C source files, search for target regions and other
6
+ code that will be offloaded to a target device, and then extract and transform
7
+ this code into new C code that can then be compiled by a target compiler into
8
+ a target image to be used as a OpenMP device binary.
9
+ The tool is part of this Clang repository and is automatically build together
10
+ with clang.
11
+
12
+ The tool comes with a regression test suite that uses ` llvm-lit ` .
13
+ The tests can be run using the CMake generated build script when the CMake
14
+ option ` SOTOC_ENABLE_TESTS ` is set to ` ON ` by running
15
+
16
+ $ make check-sotoc
17
+
18
+ To run the tests, make sure that LLVM's ` FileCheck ` tool is in the path.
19
+
You can’t perform that action at this time.
0 commit comments