Changeset 2943 for trunk/README.developer

Timestamp:

Jan 4, 2013, 7:38:38 AM (9 years ago)

Author:

Peter

Message:

merge release 0.10 into trunk

Location:

trunk

Files:

• . (modified) (1 prop)
• README.developer (modified) (1 diff)

trunk/README.developer

@@ -59 +59 @@
 way but there is still some work to do before we do exceptions in a neutral way.
 
+=== Samtools ===
+
+Code that depends on samtools API should be excluded from the build
+when configured --without-samtools, i.e., put files within
+`HAVE_LIBBAM` conditionals (or alternatively put code inside `#ifdef
+HAVE_SAMTOOL` preprocessor conditionals). In order to support multiple
+inclusion styles we do not include <bam.h> directly, but `#include
+<config_bam.h>` and `#include YAT_BAM_HEADER`. Similarly, for `<sam.h>`
+include `YAT_SAM_HEADER`. For more details on this, refer to
+`yat/omic/config_bam.h`.
+
 === Doxygen ===
 We generate our documentation using [http://www.doxygen.org Doxygen]