浏览代码

doc/doxygen: improve doc

Nathalie Furmento 12 年之前
父节点
当前提交
7ea3c182a4
共有 2 个文件被更改,包括 16 次插入1 次删除
  1. 15 0
      doc/doxygen/chapters/advanced_examples.doxy
  2. 1 1
      doc/doxygen/chapters/api/scheduling_contexts.doxy

+ 15 - 0
doc/doxygen/chapters/advanced_examples.doxy

@@ -983,6 +983,21 @@ if (ret != 0)
     error();
 \endcode
 
+To add a new kind of device to the structure starpu_driver, one needs to:
+<ol>
+<li> Add a member to the union starpu_driver::id
+</li>
+<li> Modify the internal function <c>_starpu_launch_drivers()</c> to
+make sure the driver is not always launched.
+</li>
+<li> Modify the function starpu_driver_run() so that it can handle
+another kind of architecture.
+</li>
+<li> Write the new function <c>_starpu_run_foobar()</c> in the
+corresponding driver.
+</li>
+</ol>
+
 \section Defining_a_New_Scheduling_Policy Defining a New Scheduling Policy
 
 A full example showing how to define a new scheduling policy is available in

+ 1 - 1
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -196,7 +196,7 @@ structures(like tree) implementations are foreseen.
 \var starpu_worker_collection::nworkers
         The number of workers in the collection
 \var starpu_worker_collection::type
-        The type of structure (currently STARPU_WORKER_LIST is the only one available)
+        The type of structure (currently ::STARPU_WORKER_LIST is the only one available)
 \var starpu_worker_collection::has_next
         Checks if there is another element in collection
 \var starpu_worker_collection::get_next