BDE 4.39.x Production Release
Loading...
Searching...
No Matches
bdlscm.h
Go to the documentation of this file.
1/// @file bdlscm.h
2///
3///
4/// @defgroup bdlscm Package bdlscm
5/// @brief Basic Development Library Source Control Management (bdlscm)
6/// @addtogroup bdl
7/// @{
8/// @addtogroup bdlscm
9/// @{
10/// * <a href="#bdlscm-purpose"> Purpose</a>
11/// * <a href="#bdlscm-mnemonic"> Mnemonic </a>
12/// * <a href="#bdlscm-description"> Description </a>
13/// * <a href="#bdlscm-hierarchical-synopsis"> Hierarchical Synopsis </a>
14/// * <a href="#bdlscm-component-synopsis"> Component Synopsis </a>
15///
16/// # Purpose {#bdlscm-purpose}
17/// Provide versioning information for BDE library components.
18///
19/// # Mnemonic {#bdlscm-mnemonic}
20/// Basic Development Library Source Control Management (bdlscm)
21///
22/// @see bslscm
23///
24/// # Description {#bdlscm-description}
25/// This package provides versioning information that is incorporated
26/// into every release of the 'bdl' Package Group Library. This versioning
27/// information is in turn available to all clients of 'bdl' both at run-time and
28/// by inspection of appropriate '.o' files. Note that, except for the package
29/// name, this version functionality is repeated in every package group within the
30/// BDE library suite.
31///
32/// ## Hierarchical Synopsis {#bdlscm-hierarchical-synopsis}
33///
34/// The 'bdlscm' package currently has 2 components having 2 levels of physical
35/// dependency. The list below shows the hierarchical ordering of the components.
36/// @code
37/// 2. bdlscm_version
38///
39/// 1. bdlscm_versiontag
40/// @endcode
41///
42/// ## Component Synopsis {#bdlscm-component-synopsis}
43///
44/// @ref bdlscm_version :
45/// Provide source control management (versioning) information.
46///
47/// @ref bdlscm_versiontag :
48/// Provide versioning information for the `bdl` package group.
49///
50/// @}
51/** @} */