Ignore:
Timestamp:
Dec 26, 2012, 12:20:10 AM (10 years ago)
Author:
Peter
Message:

Support different styles of including bam header files: <bam.h>,
<bam/bam.h>, and <samtools/bam.h>. Style is identified at configure
time and stored in generated 'config_public.h' by defining either
HAVE_BAM_H, HAVE_BAM_BAM_H or HAVE_SAMTOOLS_BAM_H. For convenience,
macros YAT_[B|S]AM_HEADER are defined in 'config_bam.h' that can be
used as '#include YAT_[B|S]AB_HEADER' rather than '#include
<[b|s]am.h'.

File:
1 edited

Legend:

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

    r2787 r2928  
    5959way but there is still some work to do before we do exceptions in a neutral way.
    6060
     61=== Samtools ===
     62
     63Code that depends on samtools API should be excluded from the build
     64when configured --without-samtools, i.e., put files within
     65`HAVE_LIBBAM` conditionals (or alternatively put code inside `#ifdef
     66HAVE_SAMTOOL` preprocessor conditionals). In order to support multiple
     67inclusion styles we do not include <bam.h> directly, but `#include
     68<config_bam.h>` and `#include YAT_BAM_HEADER`. Similarly, for `<sam.h>`
     69include `YAT_SAM_HEADER`. For more details on this, refer to
     70`yat/omic/config_bam.h`.
     71
    6172=== Doxygen ===
    6273We generate our documentation using [http://www.doxygen.org Doxygen]
Note: See TracChangeset for help on using the changeset viewer.