ソースを参照

add starpu_main_ram in doc

Corentin Salingue 12 年 前
コミット
28900a17c1
共有2 個のファイルを変更した14 個の追加2 個の削除を含む
  1. 4 0
      doc/doxygen/chapters/api/codelet_and_tasks.doxy
  2. 10 2
      doc/doxygen/chapters/api/data_out_of_core.doxy

+ 4 - 0
doc/doxygen/chapters/api/codelet_and_tasks.doxy

@@ -82,6 +82,10 @@ specify the codelet may be executed on a MIC processing unit.
 This macro is used when setting the field starpu_codelet::where to
 specify the codelet may be executed on an SCC processing unit.
 
+\def STARPU_MAIN_RAM
+\ingroup API_Codelet_And_Tasks
+This macro is used when the RAM memory node is specified.
+
 \def STARPU_MULTIPLE_CPU_IMPLEMENTATIONS
 \deprecated
 \ingroup API_Codelet_And_Tasks

+ 10 - 2
doc/doxygen/chapters/api/data_out_of_core.doxy

@@ -20,9 +20,17 @@ SUCCESS: return the disk node. <br />
 FAIL: return an error code. <br />
 The \p size must be at least 1 MB !
 
+\fn void * starpu_disk_open (unsigned node, void *pos, size_t size)
+\ingroup API_Out_Of_Core
+Add an existing file memory in a disk node. The \p pos is defined in the starpu_disk_ops. \p size: this is a size of your file.
+\p pos is the name of the file.
+
+\fn void starpu_disk_close (unsigned node, void *obj, size_t size)
+\ingroup API_Out_Of_Core
+Close an existing file memory opened with starpu_disk_open.
+
 \var starpu_disk_stdio_ops
 \ingroup API_Out_Of_Core
 This set uses the stdio library (fwrite, fread...) to read/write on disk. <br />
-<strong>Warning: It creates one file per allocation !</strong> 
-
+<strong>Warning: It creates one file per allocation !</strong>  <br />
 */