Changeset 4092

Timestamp:

Sep 8, 2021, 4:49:58 AM (2 years 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:

• branches/0.19-stable/README.developer (modified) (4 diffs)

branches/0.19-stable/README.developer

@@ -4 +4 @@
 
 We follow the coding style described in
-[http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines]
-[http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.pdf pdf]
-[http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.ps postscript]
+[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines]
+[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.pdf pdf]
+[https://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/c++_coding_guidelines.ps postscript]
 with the additions described here.
 
@@ -14 +14 @@
 (`make` and `make check`) when someone makes a clean checkout. There
 is a short introduction to subversion and its usage available as
-[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
+[https://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
 We follow these guidelines.
 
@@ -35 +35 @@
 
 The GSL documentation describes how
-[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html GSL error handling]
-works. The GSL library follows the thread-safe
+[http://www.gnu.org/software/gsl/manual/html_node/Error-Handling.html
+GSL error handling] works. The GSL library follows the thread-safe
 error reporting conventions of the posix Threads library. That is,
 functions return a non-zero error code to indicate an error. In most
@@ -42 +42 @@
 returns. If GSL errors occur in constructors yat handles them
 accordingly. If GSL reports errors that cannot be resolved by yat a
-[http://cbbp.thep.lu.se/~jari/documents/yat/classtheplu_1_1yat_1_1utility_1_1GSL__error.html GSL_error]
-exception will be thrown. However, the default behaviour of
-GSL library is to call abort() when unrecoverable errors occur and
+[https://cbbp.thep.lu.se/~jari/documents/yat/classtheplu_1_1yat_1_1utility_1_1GSL__error.html
+GSL_error] exception will be thrown. However, the default behaviour of
+GSL library is to call abort() when unrecoverable errors occur, which
 puts the yat (and any other) GSL error treatment out of play. For
-production environments, yat and GSL users should turn off the default
-GSL error treatment by calling gsl_set_error_handler_off(), but also
-when yat's GSL error treatment is preferred.
+production environments or when yat's GSL error treatment is
+preferred, yat and GSL users should turn off the default GSL error
+treatment either by calling gsl_set_error_handler_off() or by passing
+[https://cbbp.thep.lu.se/~jari/documents/yat/namespacetheplu_1_1yat_1_1utility.html#ac846162271bf37e091b4692ba865b178
+yat::utility::gsl_error_handler] to gsl_set_error.
 
 When new GSL functionality is introduced to yat, it is the
 responsibility of the programmer to make sure that GSL errors are
 treated properly. Proper GSL error treatment is very important in
-cases when yat users turn off the default GSL error handler since:
-
-yat aims at treating GSL errors appropriately in an
-[http://www.gotw.ca/gotw/008.htm exception safe and neutral]
-way but there is still some work to do before we do exceptions in a neutral way.
+cases when yat users turn off the default GSL error handler since yat
+aims at treating GSL errors appropriately in an
+[http://www.gotw.ca/gotw/008.htm exception safe and neutral] way but
+there is still some work to do before we do exceptions in a neutral
+way.
 
 === Samtools ===