bslscm.h

Go to the documentation of this file.

/// @file bslscm.h
///
///
/// @defgroup bslscm Package bslscm
/// @brief  Basic Standard Library Source Control Management (bslscm)
/// @addtogroup bsl
/// @{
/// @addtogroup bslscm
/// @{
/// * <a href="#bslscm-purpose"> Purpose</a>
/// * <a href="#bslscm-mnemonic"> Mnemonic </a>
/// * <a href="#bslscm-description"> Description </a>
///   * <a href="#bslscm-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bslscm-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bslscm-purpose}
/// Provide versioning information for BDE library components.
///
/// # Mnemonic {#bslscm-mnemonic}
/// Basic Standard Library Source Control Management (bslscm)
///
/// @see  balscm, bdlscm
///
/// # Description {#bslscm-description}
/// This package provides versioning information that is incorporated
/// into every release of the 'bsl' Package Group Library.  This versioning
/// information is in turn available to all clients of 'bsl' both at run-time and
/// by inspection of appropriate '.o' files.  Note that, except for the package
/// name, this version functionality is repeated in every package group within the
/// BDE library suite.
///
/// ## Hierarchical Synopsis {#bslscm-hierarchical-synopsis}
///
/// The 'bslscm' package currently has 3 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  2. bslscm_version
///
///  1. bslscm_patchversion
///     bslscm_versiontag
/// @endcode
///
/// ## Component Synopsis {#bslscm-component-synopsis}
///
///  @ref bslscm_patchversion :
///       Provide common patch versioning information.
/// 
///  @ref bslscm_version :
///       Provide source control management (versioning) information.
/// 
///  @ref bslscm_versiontag :
///       Provide versioning information for the `bsl` package group.
///
/// @}
/** @} */