doc: described open_by_lun function

6c005ba8 · Alessandro Rubini · 0bd77f5f · 6c005ba8
Commit 6c005ba8 authored Jul 05, 2012 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

fine-delay.in doc/fine-delay.in +8 -0

No files found.
--- a/doc/fine-delay.in
+++ b/doc/fine-delay.in
@@ -1056,6 +1056,14 @@ The library offers the following structures and functions:
        is found, the function return NULL with @code{EINVAL}; if either index or
        @code{dev_id} are not found, the function returns NULL with @code{ENODEV}.

+@item struct fdelay_board *fdelay_open_by_lun(int lun);
+
+	The function opens a pointer to a board, similarly to @i{fdelay_open},
+        but it uses the Logical Unit Number as argument instead. The LUN
+        is used internally be CERN libraries, and the function is needed
+        for compatibility with the installed tool-set.  The function uses
+        a symbolic link in @i{dev}, created by the local installation procedure.
+
 @end table

 The sample program @i{fdelay-list} lists the boards currently on the system,