Changeset 4092


Ignore:
Timestamp:
Sep 8, 2021, 4:49:58 AM (5 months ago)
Author:
Peter
Message:

prefer https when referring to ~jari/documents pages; mention function utility::gsl_error_handler as an alternative to turning off gsl error handling entirely.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/0.19-stable/README.developer

    r3999 r4092  
    44
    55We follow the coding style described in
    6 [http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines]
    7 [http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.pdf pdf]
    8 [http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.ps postscript]
     6[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines]
     7[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.pdf pdf]
     8[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.ps postscript]
    99with the additions described here.
    1010
     
    1414(`make` and `make check`) when someone makes a clean checkout. There
    1515is a short introduction to subversion and its usage available as
    16 [http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
     16[https://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
    1717We follow these guidelines.
    1818
     
    3535
    3636The GSL documentation describes how
    37 [http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html GSL error handling]
    38 works. The GSL library follows the thread-safe
     37[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html
     38GSL error handling] works. The GSL library follows the thread-safe
    3939error reporting conventions of the posix Threads library. That is,
    4040functions return a non-zero error code to indicate an error. In most
     
    4242returns. If GSL errors occur in constructors yat handles them
    4343accordingly. If GSL reports errors that cannot be resolved by yat a
    44 [http://cbbp.thep.lu.se/~jari/documents/yat/classtheplu_1_1yat_1_1utility_1_1GSL__error.html GSL_error]
    45 exception will be thrown. However, the default behaviour of
    46 GSL library is to call abort() when unrecoverable errors occur and
     44[https://cbbp.thep.lu.se/~jari/documents/yat/classtheplu_1_1yat_1_1utility_1_1GSL__error.html
     45GSL_error] exception will be thrown. However, the default behaviour of
     46GSL library is to call abort() when unrecoverable errors occur, which
    4747puts the yat (and any other) GSL error treatment out of play. For
    48 production environments, yat and GSL users should turn off the default
    49 GSL error treatment by calling gsl_set_error_handler_off(), but also
    50 when yat's GSL error treatment is preferred.
     48production environments or when yat's GSL error treatment is
     49preferred, yat and GSL users should turn off the default GSL error
     50treatment either by calling gsl_set_error_handler_off() or by passing
     51[https://cbbp.thep.lu.se/~jari/documents/yat/namespacetheplu_1_1yat_1_1utility.html#ac846162271bf37e091b4692ba865b178
     52yat::utility::gsl_error_handler] to gsl_set_error.
    5153
    5254When new GSL functionality is introduced to yat, it is the
    5355responsibility of the programmer to make sure that GSL errors are
    5456treated properly. Proper GSL error treatment is very important in
    55 cases when yat users turn off the default GSL error handler since:
    56 
    57 yat aims at treating GSL errors appropriately in an
    58 [http://www.gotw.ca/gotw/008.htm exception safe and neutral]
    59 way but there is still some work to do before we do exceptions in a neutral way.
     57cases when yat users turn off the default GSL error handler since yat
     58aims at treating GSL errors appropriately in an
     59[http://www.gotw.ca/gotw/008.htm exception safe and neutral] way but
     60there is still some work to do before we do exceptions in a neutral
     61way.
    6062
    6163=== Samtools ===
Note: See TracChangeset for help on using the changeset viewer.