Skip to content

Commit

Permalink
Bump version and update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
fmauger committed Jun 7, 2022
1 parent 7e49d4e commit caaaa9e
Show file tree
Hide file tree
Showing 14 changed files with 208 additions and 100 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Bayeux C++ Library for Experimental Particle and Nuclear Physics
:width: 200pt

:Authors: The BxCppDev_ group
:Date: 2022-05-03
:Date: 2022-06-07
:Contact: [email protected]

.. contents::
Expand Down Expand Up @@ -169,9 +169,9 @@ Spack_ package manager to satisfy Bayeux's software dependencies.
Releases
--------

* Latest release: `Bayeux-3.5.1`_
* Latest release: `Bayeux-3.5.3`_

.. _`Bayeux-3.5.1`: https://github.com/BxCppDev/Bayeux/releases/tag/Bayeux-3.5.1
.. _`Bayeux-3.5.3`: https://github.com/BxCppDev/Bayeux/releases/tag/Bayeux-3.5.3

.. raw:: pdf
Expand All @@ -193,25 +193,25 @@ Getting Bayeux
You can obtain the Bayeux source code from the main BxCppDev GitHub
repository.

For example, to download Bayeux version 3.5.1, you may use, assuming a
For example, to download Bayeux version 3.5.3, you may use, assuming a
Linux system:

.. code:: sh
$ cd ${HOME}
$ mkdir -p ${HOME}/BxCppDev
$ cd ${HOME}/BxCppDev
$ wget https://github.com/BxCppDev/Bayeux/archive/Bayeux-3.5.1.tar.gz
$ mkdir Bayeux-3.5.1 && \
tar xvzf Bayeux-3.5.1.tar.gz -C Bayeux-3.5.1 --strip-components=1
$ cd Bayeux-3.5.1/
$ wget https://github.com/BxCppDev/Bayeux/archive/Bayeux-3.5.3.tar.gz
$ mkdir Bayeux-3.5.3 && \
tar xvzf Bayeux-3.5.3.tar.gz -C Bayeux-3.5.3 --strip-components=1
$ cd Bayeux-3.5.3/
..

The ``${HOME}/BxCppDev/Bayeux-3.5.1/`` source directory is thus
The ``${HOME}/BxCppDev/Bayeux-3.5.3/`` source directory is thus
created.

You can now create a dedicated directory to build Bayeux 3.5.1
You can now create a dedicated directory to build Bayeux 3.5.3
following the guidelines in the *Installing Bayeux* section below.
Note that different versions of Bayeux may have slightly different
build/installation procedures, so you should read carefully the
Expand Down Expand Up @@ -309,7 +309,7 @@ managers (Linuxbrew, Spack) may help too.

.. https://github.com/BxCppDev/BxInstallers
.. _`Bayeux-3.5.1`: https://github.com/BxCppDev/Bayeux/releases/tag/Bayeux-3.5.1
.. _`Bayeux-3.5.3`: https://github.com/BxCppDev/Bayeux/releases/tag/Bayeux-3.5.3

We list below the third party softwares required by Bayeux. If some of
them are not available from the system package manager, you will have
Expand Down
6 changes: 6 additions & 0 deletions archived_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Version Release Date
3.4.3_ 2020-07-23
3.4.4_ 2021-01-10
3.5.0_ 2021-05-17
3.5.1_ 2021-04-05
3.5.2_ 2022-05-03
3.5.3_ 2022-06-07
======================= ============

.. _3.1.2: release_notes-3.1.2.rst
Expand All @@ -28,3 +31,6 @@ Version Release Date
.. _3.4.3: release_notes-3.4.3.rst
.. _3.4.4: release_notes-3.4.4.rst
.. _3.5.0: release_notes-3.5.0.rst
.. _3.5.1: release_notes-3.5.1.rst
.. _3.5.2: release_notes-3.5.2.rst
.. _3.5.3: release_notes-3.5.3.rst
43 changes: 43 additions & 0 deletions archived_notes/release_notes-3.5.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
=============================
Bayeux 3.5.2 Release Notes
=============================

Bayeux 3.5.2 adds some new features as well as fixes for reported issues.

For information on changes made in previous versions, please see
the `release notes archive`_.

.. _`release notes archive` : archived_notes/index.rst
.. contents:
Requirements
============

* Bayeux 3.5.2 requires Linux (recommended Ubuntu >=18.04, preferred
20.04, CentOS >=7.5), or macOS 10.
* Bayeux 3.5.2 depends on BxDecay >=1.1.0.

Additions
=========


Removals
=========


Changes
=======


Fixes
=====

* Refactor the ``geomtools::shape_factory`` class.


Bugs
====


.. end
43 changes: 43 additions & 0 deletions archived_notes/release_notes-3.5.3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
=============================
Bayeux 3.5.3 Release Notes
=============================

Bayeux 3.5.3 adds some new features as well as fixes for reported issues.

For information on changes made in previous versions, please see
the `release notes archive`_.

.. _`release notes archive` : archived_notes/index.rst
.. contents:
Requirements
============

* Bayeux 3.5.3 requires Linux (Ubuntu >=18.04, preferred
20.04, CentOS >=7.5), or macOS 10.
* Bayeux 3.5.3 depends on BxDecay >=1.1.0.

Additions
=========


Removals
=========


Changes
=======


Fixes
=====

* Fix bug in ``dpp::input_module`` class.


Bugs
====


.. end
2 changes: 1 addition & 1 deletion cmake/BxPackageVersions.db
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
3.2.0
3.3.0
3.4.4
3.5.2
3.5.3
# Version 4 is reserved for future Bayeux4
# We will limit this Bayeux to versions 3.X.Y
# end
11 changes: 4 additions & 7 deletions release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=============================
Bayeux 3.5.2 Release Notes
Bayeux 3.5.4 Release Notes
=============================

Bayeux 3.5.2 adds some new features as well as fixes for reported issues.
Bayeux 3.5.4 adds some new features as well as fixes for reported issues.

For information on changes made in previous versions, please see
the `release notes archive`_.
Expand All @@ -14,9 +14,9 @@ the `release notes archive`_.
Requirements
============

* Bayeux 3.5.2 requires Linux (recommended Ubuntu >=18.04, preferred
* Bayeux 3.5.4 requires Linux (Ubuntu >=18.04, preferred
20.04, CentOS >=7.5), or macOS 10.
* Bayeux 3.5.2 depends on BxDecay >=1.1.0.
* Bayeux 3.5.4 depends on BxDecay >=1.1.0.

Additions
=========
Expand All @@ -32,9 +32,6 @@ Changes

Fixes
=====

* Refactor the ``geomtools::shape_factory`` class.


Bugs
====
Expand Down
4 changes: 2 additions & 2 deletions source/bxdpp/include/dpp/base_module.h
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,9 @@ namespace dpp {

std::string _name; //!< The name of the module
std::string _description; //!< The description of the module
datatools::logger::priority _logging; //!< The logging priority threshold
datatools::logger::priority _logging = datatools::logger::PRIO_FATAL; //!< The logging priority threshold

bool _initialized; //!< The initialization flag
bool _initialized = false; //!< The initialization flag
std::string _last_error_message; //!< Last error message (questionable)

// Factory stuff :
Expand Down
12 changes: 6 additions & 6 deletions source/bxdpp/include/dpp/input_module.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/// \file dpp/input_module.h
/* Author(s) : Francois Mauger <[email protected]>
* Creation date : 2013-08-16
* Last modified : 2013-12-13
* Last modified : 2022-06-06
*
* Copyright (C) 2013 Francois Mauger <[email protected]>
* Copyright (C) 2013-2022 Francois Mauger <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -161,10 +161,10 @@ namespace dpp {

private:

bool _clear_record_; //!< A flag to automatically clear the data record before processing
boost::scoped_ptr<io_common> _common_; //!< Common data structure
i_data_source * _source_ = nullptr; //!< Abstract data reader
bool _metadata_updated_ = false; //!< Flag for possible metadata update
bool _clear_record_ = false; //!< A flag to automatically clear the data record before processing
std::unique_ptr<io_common> _common_; //!< Common data structure
i_data_source * _source_ = nullptr; //!< Abstract data reader
bool _metadata_updated_ = false; //!< Flag for possible metadata update

// Macro to automate the registration of the module :
DPP_MODULE_REGISTRATION_INTERFACE(input_module)
Expand Down
24 changes: 12 additions & 12 deletions source/bxdpp/include/dpp/io_common.h
Original file line number Diff line number Diff line change
Expand Up @@ -192,28 +192,28 @@ namespace dpp {

// Configuration attributes:
std::string _module_name_; //!< Name of the associated module
io_type _io_; //!< I/O flag
format_type _format_; //!< Format flag
datatools::logger::priority * _logging_; //!< Handle to the logging priority of the associated module
int _max_record_per_file_; //!< Maximum number of event records per file
int _max_record_total_; //!< Maximum number of event records to be processed
int _max_files_; //!< Maximum number of data files to be processed
io_type _io_ = IO_INVALID; //!< I/O flag
format_type _format_ = FORMAT_INVALID; //!< Format flag
datatools::logger::priority * _logging_ = nullptr; //!< Handle to the logging priority of the associated module
int _max_record_per_file_ = 0; //!< Maximum number of event records per file
int _max_record_total_ = 0; //!< Maximum number of event records to be processed
int _max_files_ = -1; //!< Maximum number of data files to be processed
datatools::smart_filename _filenames_; //!< Smart list of data filenames

// Running/dynamic attributes:
bool _terminated_; //!< Termination flag
int _file_record_counter_; //!< Event record counter in the current file
int _record_counter_; //!< Total event record counter
int _file_index_; //!< Index of the current datafile index
bool _terminated_ = false; //!< Termination flag
int _file_record_counter_ = 0; //!< Event record counter in the current file
int _record_counter_ = 0; //!< Total event record counter
int _file_index_ = -1; //!< Index of the current datafile index

// Metadata support:
datatools::multi_properties _metadata_store_; //!< Embedded metadata container

// Context service (external metadata container):
std::string _Ctx_label_; //!< The label/name of the context service
dpp::context_service * _Ctx_service_; //!< The handle to the context service
dpp::context_service * _Ctx_service_ = nullptr; //!< The handle to the context service
std::vector<std::string> _Ctx_metadata_; //!< The list of labels of the metadata to be taken into account
bool _Ctx_metadata_all_; //!< Flag to accept all metadata
bool _Ctx_metadata_all_ = false; //!< Flag to accept all metadata

};

Expand Down
15 changes: 8 additions & 7 deletions source/bxdpp/include/dpp/output_module.h
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/// \file dpp/output_module.h
/* Author(s) : Francois Mauger <[email protected]>
* Creation date : 2013-08-16
* Last modified : 2014-01-15
* Last modified : 2022-06-06
*
* Copyright (C) 2013-2014 Francois Mauger <[email protected]>
* Copyright (C) 2013-2022 Francois Mauger <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand All @@ -30,9 +30,10 @@
#ifndef DPP_OUTPUT_MODULE_H
#define DPP_OUTPUT_MODULE_H 1

// Standard library:
#include <memory>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/smart_filename.h>

Expand Down Expand Up @@ -145,9 +146,9 @@ namespace dpp {

private:

bool _preserve_existing_output_; //!< Flag to preserve existing output files
boost::scoped_ptr<io_common> _common_; //!< Common data structure
i_data_sink * _sink_ = nullptr; //!< Abstract data writer
bool _preserve_existing_output_ = false; //!< Flag to preserve existing output files
std::unique_ptr<io_common> _common_; //!< Common data structure
i_data_sink * _sink_ = nullptr; //!< Abstract data writer

// Macro to automate the registration of the module :
DPP_MODULE_REGISTRATION_INTERFACE(output_module)
Expand Down
Loading

0 comments on commit caaaa9e

Please sign in to comment.