Browse code

core: load_module - updated function docs

Daniel-Constantin Mierla authored on 29/05/2009 11:02:20
Showing 1 changed files
... ...
@@ -243,11 +243,14 @@ static inline int version_control(void *handle, char *path)
243 243
 }
244 244
 
245 245
 /** load a sr module.
246
- * tries to load the module specified by path.
247
- * If modname does contain a '/' or a '.' it would be assumed to contain a 
248
- * path to the module and it will be used as give.
249
- * else <MODS_DIR>/<modname>.so will be tried and if this fails
246
+ * tries to load the module specified by mod_path.
247
+ * If mod_path is 'modname' or 'modname.so' then
248
+ *  <MODS_DIR>/<modname>.so will be tried and if this fails
250 249
  *  <MODS_DIR>/<modname>/<modname>.so
250
+ * If mod_path contain a '/' it is assumed to be the 
251
+ * path to the module and tried first. If fails and mod_path is not
252
+ * absolute path (not starting with '/') then will try:
253
+ *   <MODS_DIR>/mod_path
251 254
  * @param modname - path or module name
252 255
  * @return 0 on success , <0 on error
253 256
  */