From f3b1697bd5532536ba35b8a14baff3271042456a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20J=C3=BCnger?= Date: Tue, 8 Aug 2023 15:54:27 +0200 Subject: [PATCH 1/3] Update RELEASENOTES.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Align the supported platforms with the SystemC reference implementation. Remove formerly supported platforms. Update information on SystemC version to 2.3.3 and following. Signed-off-by: Lukas Jünger --- RELEASENOTES.md | 57 ++++++------------------------------------------- 1 file changed, 6 insertions(+), 51 deletions(-) diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 233ad0e0..337dc81f 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -14,7 +14,7 @@ Overview This package contains the reference implementation for the SystemC Configuration, Control and Inspection (CCI) standard. It works optimally with -SystemC 2.3.3 utilizing its hierarchical name registry to detect and mitigate +SystemC 2.3.3+ utilizing its hierarchical name registry to detect and mitigate parameter name collisions. On prior versions of SystemC, it doesn't address name collisions but otherwise works fine. @@ -24,60 +24,15 @@ Supported platforms and tool dependencies ### Supported platforms -This release is supported on the following platform combinations for -which it has been tested: - - * 64-bit Linux (x86_64) - (RedHat Enterprise 6; SuSE Enterprise Linux 11; Debian 9) - - GNU C++ compiler versions gcc-4.2.2 through gcc-8.2.0 - - Clang C++ compiler versions clang-3.4 through clang-6.0 - - Intel C++ Compiler (ICC 15.0.0) - - * 64-bit Linux (x86_64) with 32-bit compiler (--host=i686-linux-gnu) - (SuSE Enterprise Linux 11) - - GNU C++ compiler versions gcc-4.2.2 through gcc-8.2.0 - - Intel C++ Compiler (ICC 15.0.0) - - * 64-bit Linux (aarch64) - (Ubuntu 16.04) - - GNU C++ compiler version gcc-4.5.0 - - * 64-bit Mac OS X (x86_64) - (10.12 Sierra) - - Apple LLVM version 8.0 (clang-800.0.42.1) - - GNU C++ compiler (MacPorts) versions gcc-4.9.0, gcc-5.4.0, gcc-6.3.0 - - * Microsoft Windows 10 - - Microsoft Visual Studio 2010 (10.0) (Win32 and x64) - - Microsoft Visual Studio 2013 (12.0) (Win32 and x64) - - Microsoft Visual Studio 2015 (14.0) (Win32 and x64) - - Microsoft Visual Studio 2017 (14.1) (Win32 and x64) - - Warning: The fixed-point datatypes are not working as defined on - MSVC 2015/2017 (x64) in Release mode. See RELEASENOTES. - - * Windows Server 2008 (WoW64), Msys 1.0.17(0.48/3/2) - - MinGW-w64 GNU C++ compiler version 4.9.2 (x86_64) - -### Formerly supported platforms - -This release has not yet been tested or is known not to work as expected -on the following formerly supported platforms: - - * GNU C++ compiler versions prior to 4.2.x (all platforms) - * FreeBSD 9.0 or later (x86, x86_64) with GNU C++ compiler - * HP-UX 11.00 or later with GNU C++ or HP C++ compiler - * Sun/Oracle Solaris, with GNU C++ or Sun/Solaris Studio compiler - * Mac OS X prior to 10.12 (Sierra) and/or on the x86, PowerPC architectures - * Microsoft Visual C++ versions prior to 10.0 (2010) - * Cygwin 1.7 or later (x86, x86_64) with GNU C++ compiler - * Msys/MinGW32 GNU C++ compiler +This release is supported on the same platforms as the Accellera SystemC +reference implementation. These are documented in the SystemC reference +implementation RELEASENOTES. ### Tool dependencies SystemC CCI requires the following additional tools - * SystemC 2.3.3 reference implementation, or commercial equivalent, + * SystemC 2.3.3+ reference implementation, or commercial equivalent, https://accellera.org/downloads/standards/systemc * RapidJSON, latest version (Github master), @@ -150,4 +105,4 @@ forums: [support]: #supported-platforms-and-tool-dependencies [new]: #whats-new-in-this-release [problem]: #known-problems -[bugs]: #reporting-bugs-and-suggestions \ No newline at end of file +[bugs]: #reporting-bugs-and-suggestions From 40d01ad5cb250d576d4167e510867933fbd21abe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20J=C3=BCnger?= Date: Tue, 8 Aug 2023 15:55:37 +0200 Subject: [PATCH 2/3] Remove ChaneLog file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Lukas Jünger --- ChangeLog | 1972 --------------------------------------------------- Makefile.am | 1 - 2 files changed, 1973 deletions(-) delete mode 100644 ChangeLog diff --git a/ChangeLog b/ChangeLog deleted file mode 100644 index 2097a0c9..00000000 --- a/ChangeLog +++ /dev/null @@ -1,1972 +0,0 @@ -ChangeLog ---------- - -Nov 14, 2019 -Merge pull request #250 from /intel-doc-license-notice -Update NOTICE -Merge pull request #252 from /intel-feature-sc_variant - -Nov 10, 2019 -cci_rapidjson.h: decode JSON parse error -cci_value: add explicit copy constructor to reference types - -Nov 6, 2019 -Fix typo (Saint-Exupery) - -Sep 2, 2019 -cci_value: report error upon JSON parsing failure - -Aug 10, 2019 -cci_value: sc_variant -> sc_any_value - -Apr 17, 2019 -ex07_Parameter_Information: use explicit constructor for C++17 -cci_value: use sc_variant, if available - -Apr 15, 2019 -cci_value: add missing cci_value::try_set -cci_value: add conversion support for fixpoint types -cci_value: opt-in converter support -Update RapidJSON submodule -cci_param_untyped_handle: remove virtual functions -cci_value_converter: move instantiations after specializations -Makefile: allow variadic macros - -Aug 1, 2018 -Updated NOTICE file to align with systemc. - -Jun 15, 2018 -Merge pull request #248 from /intel-cleanup-add_ex19_project -Merge pull request #247 from /intel-feature-broker-memfn-cb -Add release note about cci_broker_handle update to suupport callback -Add Example 19 visual studio project file (had been filtered out) -cci_broker_handle: add overloads for member function callbacks -Add Example 19 golden log that got ignored by filter. -Merge pull request #246 from /intel-cleanup-release_1_0_prep -Merge pull request #245 from /intel-cleanup-interface-classes - -Jun 14, 2018 -README cleanups -Revert "Merge the callbacks interface directly into cci_broker_if" -Release 1.0.0 version info -Update READMEs for the 1.0 release. - -Jun 13, 2018 -Merge pull request #244 from /intel-fix-bhandle-orig-propagation -inline promote_originator() in handles for efficiency -Merge the callbacks interface directly into cci_broker_if -Disable copy ctor and assignment for interface classes - -Jun 11, 2018 -Init originator from current context in copy ctor -Remove propagation of originator in broker handles -Merge pull request #243 from /intel-fix-name_return_type -Add namespace and header for cstring functions - -Jun 7, 2018 -Consistently use char* as name() return type - -May 24, 2018 -Merge pull request #241 from /intel-fix-originator-sc_object-ctor - -May 16, 2018 -Remove cci_originator::get_parent_originator() -Make ctor with sc_object argument protected -Remove originator ctor with sc_object arg -Merge pull request #240 from /intel-fix-long-pathnames - -May 9, 2018 -Truncate examples paths - -May 6, 2018 -Merge pull request #239 from /intel-fix-name-query; closes #235. -Remove temp name() for consistency - -May 4, 2018 -Rename cci_param_if::get_name() to name() -Merge pull request #232 from /intel-cleanup-cadence-feedback -Fix formatting only. -Fix inability to specify a single test(s) reported by some users - -Apr 19, 2018 -Remove initialization of SYSTEMC_TEST -Merge pull request #236 from /intel-fix-clang60 - -Apr 18, 2018 -cci_broker_handle: add missing include and const - -Mar 30, 2018 -More updates to address Ericsson & Cadence public review feedback. -Cleanup to address public review feedback from Ericsson & Cadence - -Mar 28, 2018 -Merge branch 'intel-fix-example24' - -Mar 27, 2018 -Merge pull request #229 from markfoodyburton/201-203-originator-cleanup - -Mar 21, 2018 -Added a comment that the originator is explicitly omitted from the as -Remove originator copies from handle assignes and ensure proper const -Remove local originator from broker implementations - -Mar 12, 2018 -Rename Example24 as Example19 -Add PowerPoint for Reset example. - -Mar 2, 2018 -Process callbacks consistently during parameter reset() -Add cci_broker_if::get_preset_value_origin(). - -Mar 1, 2018 -Example 24 cleanups - -Feb 8, 2018 -Merge pull request #225 from /intel-fix-ex16 -Updates to Example24. - -Feb 8, 2018 -Update value originator before post-write cb in set_raw_value() -Change init() sequence to apply preset before adding param to broker - -Feb 7, 2018 -Revamped reset() -A better fix for recording originator of an updated preset value. -ex16: move converter specialization CCI namespace - -Feb 6, 2018 -Updated to show reset behaviors. -Add const to cci_param_untyped_handel::is_default_value() - -Jan 5, 2018 -Restore example24 in order to fix it. - -Dec 19, 2017 -Merge pull request #223 from /intel-cleanup-examples_ppt -Fix Linux instructions (final prep for public review) -Merge pull request #222 from /intel-fix-msvc10-mdd -MSVC'2010: explicitly select /MDd for Debug builds -Merge pull request #221 from /intel-sync-verify-pl -Cleanup for public review -Remove MT/d RuntimeLibrary overrides -Merge branch 'systemc-regressions/verify-pl' into intel-sync-verify-pl - -Dec 17, 2017 -Merge pull request #220 from /intel-cleanup-instructions -Merge pull request #219 from markfoodyburton/fix-ignore-unconsumed -Final cleanup of instructions. -fix to take ignored predicates into account for unconsumed. -Merge pull request #218 from /intel-fix-callbacks -cci_param_untyped: add missing callback unregistration -Merge pull request #217 from /intel-cleanup-ppt-terminology-part4 -Merge pull request #216 from /intel-cleanup-ppt-terminology-part3 -Merge pull request #215 from /intel-cleanup-ppt-terminology-part2 -Merge pull request #213 from /intel-cleanup-tarball -Merge pull request #214 from /intel-msvc10-cleanups -Add note about DLL defaults on Windows -Update Ex05 project filenames to match example -Clean examples for public review. -Cleanup examples for public review. - -Dec 15, 2017 -Cleanup examples 5-10 for public review. -Fix some compiler warnings on MSVC'2010 -Update MSVC'2010 solution and project files -Add note about Windows archiver limitation & workaround -Fix export-ignore and update version date for release tarball - -Dec 14, 2017 -Merge pull request #212 from /intel-cleanup-remove-example19 -Merge pull request #210 from /intel-cleanup-disable-example24 -Merge pull request #209 from /intel-cleanup-export-example26 -Remove Example 19 -Merge pull request #208 from /intel-cleanup-readmes -Disable example 24 in preparation for public review release -Remove Example 26 - -Dec 13, 2017 -Fixes based on PR feedback. -Add AUTHORS for release kit. -Update README and related files in preparation for public review. - -Dec 12, 2017 -Merge pull request #207 from /intel-cleanup-LRM-alignment -Merge pull request #205 from /intel-fix-cleanup-cci_broker_if- - -Dec 8, 2017 -Call param destroy callbacks before unregistering param -Update set() to set_value() in comment. -Make password argument to set_cci_value() const. -Make cci_broker_if dtor protected - -Dec 5, 2017 -Remove cci_broker_if is_used() and param_exists(). - -Nov 30, 2017 -Merge pull request #194 from /intel-cleanup-ppt-terminology - -Nov 15, 2017 -Powerpoints updated to reflect new semantics and logfiles. -PPT terminology updates and cleanup - -Nov 7, 2017 -Merge pull request #200 from /intel-cleanup-integral-type - -Nov 3, 2017 -Merge pull request #199 from /intel-misc-cleanup -Merge pull request #197 from /intel-fix-typed-handle -Update & fix MSVS project and filters. - -Nov 2, 2017 -CCI_NUMBER_(PARAM,VALUE) -> CCI_INTEGRAL_(PARAM,VALUE) -Doxygen updates -MSVC: add source/header file filters -examples: fix compiler warnings -README.txt: update build instructions -Makefile improvements -drop unused Makefile.defs -cci_filtered_range: rename nested class -cci_value_converter: leverage SystemC 2.3.2 -cci_param_typed(_handle: set() -> set_value() -Drop implicit handle reattach upon parameter resurrection -cci_(broker|param)_if: make create_*_handle non-virtual -Add cci_param_cast convenience function -cci_param_typed/cci_param_if/*_handle: cleanups and fixes -cci_broker_handle: cleanups and fixes -cci_abort: delegate to sc_abort on SystemC 2.3.2 -Merge pull request #195 from markfoodyburton/139-get-broker-cleanup -Update vcxproj file for PR195. -Update Ex19 golden logfile. - -Nov 1, 2017 -minor fixes to comments, and register broker will silently accept re- - -Oct 30, 2017 -move broker_manager to use 'raw' sc_object hierarchy - -Oct 26, 2017 -Change the 'LRM' functions from being cci_broker_manager::get_broker - -Oct 24, 2017 -modifications to how the global broker is dealt with: - -Sep 30, 2017 -Changes to cleanup get_broker and remove the need to pass the origina - -Sep 28, 2017 -Merge pull request #193 from markfoodyburton/26_change_Intial_Preset -Change "Initial" to "Preset" accross the board. - -Sep 27, 2017 -Merge pull request #192 from /intel-fix-init-destroy -cci_param_if: improve originator interface - -Sep 23, 2017 -cci_param_if: improved initialization/destruction & cleanups - -Sep 22, 2017 -cci_param_untyped_handle: fix lifetime handling -Merge pull request #190 from markfoodyburton/182-remove-elaboration-m - -Sep 20, 2017 -basic removal of elaboration-mutable as a type of mutability - -Sep 11, 2017 -Merge pull request #188 from /intel-cleanup-misc - -Sep 10, 2017 -cci_global_cfg_broker: cleanups -Don't use 'cci::' namespace directly -RapidJSON: suppress -Wterminate warning on GCC 6.0 or later -RapidJSON: move symbols into cci_impl namespace - -Sep 5, 2017 -Merge pull request #183 from markfoodyburton/171_lock_cleanup - -Sep 4, 2017 -Slightly better fix in ex19 (which should be reworked/removed anyway) - -Sep 2, 2017 -Merge pull request #187 from /intel-cleanup-greencontrol -Merge pull request #186 from /-intel-cleanup-PR179 -Additional submodule cleanup - -Sep 1, 2017 -Merge pull request #185 from markfoodyburton/152-broker-api-update -added anonymous namespace - -Sep 1, 2017 -Drop more GS references -Fixes in accordance with discussion. Base 'globality' on a virtual fu -Drop GreenControl submodule leftovers -Futher cleanup to lock, and removal of some excess in param_if (as pe -fixes for #171 to cleanup the way lock works -Merge pull request #184 from markfoodyburton/missing_map_include -MSVS cleanup for PR179 -Merge pull request #179 from /intel-feature-error-handling - -Aug 31, 2017 -Trivial missing causing some gcc's to cry. -cci_abort: temporarily disable call to sc_abort -Merge pull request #180 from /intel-fix-remove-gs-submodules -Merge pull request #178 from /intel-cleanup-originator - -Aug 29, 2017 -Merge pull request #177 from /intel-cleanup-cmnhdr-includes -Merge pull request #181 from /intel-fix-cci_value-pointer_traits -cci_value: add support for pointer_traits -Merge pull request #176 from /intel-feature-cci_value-move -cci_report_handler: remove unneeded header fil -Remove gs submodules - -Aug 27, 2017 -Harden error paths (closes #144) -cci_report_handler: improve error handling (closes #175) -cci_originator: add move support, cleanups -cleanup includes (no functional changes) -cci_cmnhdr.h: sync with SystemC -cci_value: add move support - -Aug 25, 2017 -Merge pull request #170 from /intel-feature-cci_value-at-insert - -Aug 10, 2017 -Merge pull request #169 from /intel-cleanup-ns-detail -ex16: fix user-defined datatype converter - -Aug 8, 2017 -cci_value_list: implement missing insert overload -cci_value_map: move const find overloads to cref -cci_value_map: refine key-based access -cci_value_list: refine element-wise access -Rename cci::detail namespace to cci::cci_impl - -Aug 7, 2017 -Merge pull request #166 from /intel-fix-callback-exceptions - -Aug 6, 2017 -Merge branch 'markfoodyburton-fix-164' -Update golden regression log. -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge branch 'markfoodyburton-fix-164' -Aug 6, 2017 -Fix outdated invalidate() call using an argument. -Merge branch 'fix-164' of https://github.com/markfoodyburton/cci into - -Aug 5, 2017 -verify.pl: update MSVC runtime default - -Jul 13, 2017 -Merge pull request #163 from markfoodyburton/examples-fixes -Merge pull request #162 from /intel-fixes-gsbroker-removal - -Jul 6, 2017 -Add exception safety to parameter callback handling - -Jul 3, 2017 -Fixes to resolve issue/164. - -May 11, 2017 -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #160 from /intel-feature-cci_value -Merge branch 'master' into intel-feature-cci_value -Merge pull request #161 from /intel-fixes-cxx11 - -May 9, 2017 -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge branch 'master' of github.com:markfoodyburton/cci -move fast_read/write mechanism to untyped param so it better tracks u - -May 8, 2017 -move example to cci_param -fixes to add new API members (and remove supurious call to get_defaul -The current private broker requires fully qualified names. -this used set_init_value to set values, whether they were initialized -ex07 relied on the is_default_value being a flag, e.g. when the value -fix for example 5 (seems to be working correctly, a comment was wrong -Remove lazy (and horrid) variadic macro, and fix up iterators to work - -May 4, 2017 -Removing lingering referneces to the GS broker now that the POC inclu - -Apr 29, 2017 -cci_value: add rapidjson::StringOutputStream - -Apr 21, 2017 -Use template aliases on C++11 -Add and use CCI_TPLEXTERN_ (see osci-wg/systemc#187) -rapidjson: avoid -Wterminate warning on GCC in C++11 -fixes for SystemC 2.3.2 and C++11 mode -Add CCI_CPLUSPLUS to determine the C++ baseline -Merge branch 'markfoodyburton-with-broker' -Merge branch 'with-broker' of https://github.com/markfoodyburton/cci - -Apr 20, 2017 -use CCI_TPLEXTERN_ (requires #161) - -Apr 17, 2017 -cci_value: add free-standing swap overload to mutable references -cci_value: avoid taking the address of proxy objects -cci_value: add iterator interface -cci_value: add missing string comparison overload -cci_value: guard against self-assignment -cci_value: fix comparison of null values -cci_value: (documentation) cleanup -cci_value: add simple pool for top-level objects -cci_value: update to RapidJSON v1.1.0 - -Apr 13, 2017 -adopt the agreed semantice: -added and use has_initial_value -remove inheritence of broker_manager -a number of minor fixes (const's and other niceness) - -Apr 10, 2017 -remove the m_is_* from the param's -use try_get to make is_initial_value more robust, and to correctly id -use a try_get to better evaluate is_initial_value -check whether a param exists as well as the euqality of its initial v -more const and indent fixes for the broer handle this time -better null cci_value return -more const cleaning -consistent use of const for functions (and return types) - -Apr 9, 2017 -fixed comment -change the name 'implicit' to 'initial value' -make constructor explict -Fixed ordering issue in constructor -adjust ordering of members to avoide a -Wreorder issue. -modified include paths to consistently use prefixes - -Apr 7, 2017 -Merge branch 'lrm_prep_cci_value' -Rename cci_value_category enum values with VALUE vs. DATUM. -Rename cci_value's basic_type to be consistent with cci_param category. -Rename cci_value converter macros for clarity (CCI_VALUE_CONVERTER_EN -Update Ex07 to reflect renaming of get_basic_type() to get_data_categ - -Apr 5, 2017 -Rename get_basic_type() to get_data_category(). -Fix case for CCI_VALUE_CONVERTER substitutions. - -Feb 28, 2017 -example to show simple TLM usage and check speed of parameters -This is an experimental commit to improve the speed of parameter acce -fix post read to actually be post read ! - -Feb 27, 2017 -Initial commit to change is_default and initial _value calls to calcu -Fix to ordering bug in broker (corrupted used parameter values) - -Feb 24, 2017 -Reset all (instantiated) parameters at the end of elaboration (e.g. i - -Feb 23, 2017 -better reset handling for param's (taking into account if an init val -remove get_param_handles with a string once and for all (hopefully). - -Feb 19, 2017 -vsvars.bat: update default to MSVC 2010 - -Feb 16, 2017 -Merge pull request #157 from /ex_clean -param names are always absolute, the relative handling in the broker -Update file names/locations for moving cci_value into cci_core/. -Group renaming and some slight declaration reordering to align with L - -Feb 15, 2017 -Split cci_data_type into separate roles for cci_value datum (cci_valu -Modified ex14 to use private broker, but note the old private broker -Remove the entire get_cci_value_keep_unused interface as it seems to -Add a reset method to typed parameters, and to untyped handles -Adding broker implementation: An instance is used for the global brok - -Feb 14, 2017 -add doc for compile and run cci examples -update example sldes - -Feb 11, 2017 -update example sldes -update name -Remove extraneous ctor. - -Feb 10, 2017 -Rename cci_value_traits to cci_value_converter. - -Feb 6, 2017 -Remove CR at end of command-line - -Feb 5, 2017 -examples update - -Feb 4, 2017 -Update comments to distinguish disabled (no conversion) from disallow -Remove bounds check todo comments; resulting truncation is fine for i -Move cci_value and cci_value_traits (along with rapidson.h) to the cc -Move cci_value and cci_value_traits (along with rapidson.h) to the cc - -Feb 3, 2017 -Merge pull request #156 from /vcxproj_update - -Feb 1, 2017 -Fix the list of include files to match the current code base. - -Jan 31, 2017 -Merge branch 'master' of https://github.com/OSCI-WG/cci into lrm_prep -Merge pull request #155 from /intel-sync-verify-pl -Merge pull request #151 from guyguy333/fix-link -Merge branch 'guyguy333-fix-link' into lrm_prep_cci_value -Merge branch 'fix-link' of https://github.com/guyguy333/cci into guyg -Add include required for latest MSVS2015 compiler. - -Jan 29, 2017 -example PowerPoint updates -cleanup -update a naming from parameter_container to parameter_owner - -Jan 22, 2017 -renaming and clean up -renaming and clean up -Sync with upstream branch 'verify.pl' - -Jan 11, 2017 -Avoid printing of comments in vsvars.bat - -Dec 22, 2016 -Merge pull request #154 from /dev_ex_to_reg_repo - -Dec 21, 2016 -Update instructions for running all examples. -Remove dev_examples references in the README files. -update tests results with all dev_examples removed -dev_examples and their git histories are moved to cci-regressions rep -Merge branch '-MSVS-project-file-for-Example-#22' -Merge branch 'MSVS-project-file-for-Example-#22' of https://github.co -Merge branch '-MSVS-project-file-for-Example-#22' -Minor updates and reformatting of PowerPoint presentations. -Merge branch 'MSVS-project-file-for-Example-#22' of https://github.co - -Dec 20, 2016 -Merge pull request #138 from /Updated-powepoint-slides-to- -Various refinements of the PowerPoint presentations. -Remove catching of (intended) exceptions which resulted in double rep -Add cpp FILE and LINE info when reporting issues. This reflects a loc -Remove set_actions override (for severity >= SC_ERROR); we should not -Merge branch '-Updated-powepoint-slides-to-reflect-changes -Merge branch 'Updated-powepoint-slides-to-reflect-changes-in-examples - -Dec 19, 2016 -Merge pull request #149 from guyguy333/255-remove-get-param-list -Update gs_broker submodule reference. - -Dec 16, 2016 -Updated with m_broker and fixed merge conflict - -Dec 15, 2016 -src: fix circular link dependency and static initialization -cci_cfg/cci_originator: fix compatibility with old compilers -examples/dev_examples: fix examples with unconsumed values API -cci_cfg: remove get_param_list() - -Dec 14, 2016 -Merge branch '-dev_ex_rm_clean'; closes #22 and closes #86. -Merge pull request #147 from guyguy333/253-cci-broker-handle -Update GS submodule references for PR#147. -Update MSVS project files with cci_broker_handle updates. -uplift -its on Dec 14, 2016 -cci_cfg: add cci_broker_handle - -Dec 13, 2016 -Merge pull request #148 from guyguy333/254-remove-cci-debug -Merge pull request #137 from guyguy333/152-unconsumed-parameter -Update gs_broker submodule reference. -Merge branch '152-unconsumed-parameter' of https://github.com/guyguy3 -cci_cfg: remove cci_debug - -Dec 12, 2016 -cci_filtered_range: fix initialization -cci_broker_if: add cci_name_value_pair type - -Dec 11, 2016 -add ppt for ex23 -refactoring data names -refactoring - -Dec 9, 2016 -using reset api -add reset api - -Dec 8, 2016 -name update -rm is_initial_value_example and the missing feature is added into ex05 -add set_initial_cci_value test after construcntion which is treated a -removed gs_example and one feature is converted to broker_get_originator -demo broker to get originator which is showed in gs_example. gs_examp -change name for compare relevant examples -change name for cci_value relevant examples - -Dec 7, 2016 -register_create_callback api demostrated in these two dev example has - -Dec 4, 2016 -update format to example styple -move hierarchical value set from dev to example - -Dec 1, 2016 -Update gs_broker submodule reference. - -Nov 29, 2016 -Added new CODING STYLE.txt and added power point slides for ex21 and - -Nov 28, 2016 -cci_filtered_range: various fixes -cci_filtered_range: improve the filter and iterator class -examples/ex05: add unconsumed initial cci value example -cci_broker_if: replace cci_param_filter_iterator with cci_param_range -examples/ex22: update with new API -cci_cfg: add unconsumed initial cci value querying and filtering support -cci_filtered_range: refactoring with nested iterator class -cci_filtered_range: rename cci_filter_iterator to cci_filtered_range -cci_filter_iterator: make the container configurable through a templa -cci_core: move cci_param_filter_iterator to a more generic cci_filter - -Nov 22, 2016 -Merge branch '-Replace-ASI-with-Accellera-in-sc_report-msg -Merge pull request #112 from guyguy333/134-broker-stack -Update greensocs submodule references. -cci_broker_manager: remove "cache" for calls to get_broker() and prin -cci_broker_manager: remove the originator parameter -examples/ex14: creates a specific private broker hierarchy -examples/ex14: update with the latest cci_broker_manager API -dev_examples/priv_broker_example: introduce a subtop to separate priv -dev_examples/priv_broker_example: remove uneeded explicit private bro -cci_originator: add is_unknow() -cci_broker_if: return get_latest_write_originator by value -cci_originator: simplify unknow originator creation -cci_originator: update operator== and operator< with the new logic - -Nov 17, 2016 -dev_examples/priv_broker_example: remove outdated comment -examples+dev_examples: remove the uneeded broker argument - -Nov 16, 2016 -dev_examples+examples: move cci_broker_if pointer to reference -cci_broker_if: rename create_global_cnf_broker to cci_get_global_broker -scripts/results: fix summary.txt -examples/ex06: move cci name type to CCI_ABSOLUTE_NAME for sc_main pa -examples+dev_examples: omit cci_originator argument of get_broker whe -dev_examples/broker_hierarchy: remove broker pointer - -Nov 15, 2016 -Merge branch 'Updated-powepoint-slides-to-reflect-changes-in-examples -scripts/results/summary: update with latest fixes -cci_param_untyped_handle: protect operator= against self assignement -dev_examples: add broker hierarchy example -cci_originator: update operator == and < -cci_originator: remove uneeded else -cci_originator: move swap method to public and update doc -cci_broker_manager: rename get_current_(parent_)broker() to get_(pare -cci_broker_manager: make get_current_parent_broker protected -examples/ex14: update to the latest cci_broker_manager API -cci_broker_manager: return the provided broker after registration for -examples/ex14_Hiding_Parameters: update to the new cci_broker_manager -dev_examples/priv_broker_example: update to the new cci_broker_manage -dev_examples/priv_broker_example: remove unused code -dev_examples/priv_broker_example: remove SC_INCLUDE_DYNAMIC_PROCESSES -cci_broker_manager: set originator argument as optional -cci_broker_manager: add register_broker method -cci_originator: fix compare operator -cci_originator: add get_parent_originator() -cci_broker_manager: simplify implementation -cci_originator: simplify constructor API -cci_originator: fix operator= memory leak -cci_originator: forbid empty originator - -Nov 14, 2016 -Updated examples 1-4 to remove outdated terminolgy and code. -cci_originator: simplify current_originator_object() -cci_cfg: fix broker stack -cci_originator: prefer __CCI_UNKNOWN_ORIGINATOR_STRING__ instead of a - -Nov 10, 2016 -Merge pull request #135 from /intel-sync-verify-pl -Merge pull request #133 from guyguy333/sc-dynamic-processes -Merge pull request #111 from guyguy333/153-search-predicate -Update gs_broker submodule reference for PR111. -scripts/results: update summary.txt -examples/ex22: add predicate example -Sync with upstream branch 'verify.pl' -cci_cfg: add predicate support -cci_cfg: introduce cci_param_filter_iterator class -cci_core/systemc: include SystemC dynamic processes support by default -vsvars.bat: add documentation+licensing - -Nov 9, 2016 -More update on log files to sync with OSCI-WG/ master -Merge branch 'master' of https://github.com/OSCI-WG/cci into Replace- -Update GreenSocs submodule references associated with PR127. - -Nov 8, 2016 -Updated log files -Merge branch 'master' of https://github.com/OSCI-WG/cci into Replace- - -Nov 7, 2016 -Changed "ASI" to "Accellera" and updated all log files- Resolves #131 -Merge pull request #127 from guyguy333/238-gs-param-dependency - -Nov 6, 2016 -dev_examples/gs_example: remove the catch clause and update default v -dev_examples/callback_example: remove the catch clause and use the ri - -Nov 4, 2016 -verify.pl: change license to Apache-2.0 - -Nov 3, 2016 -Merge pull request #130 from guyguy333/move-cci-core-types - -Nov 2, 2016 -scripts/results/summary: GPU meter is now 100% -cci_param_untyped_handle: add operator= -examples/ex14: add conflict name warning to the golden file -examples/ex19: fix build and golden file -examples/ex16: fix pre read callback originator -examples/ex08: fix pre read callback originator -examples/ex07: fix golden log -cci_cfg: add get_cci_value(originator) to fix pre/post read callback -cci_cfg: rename get_default_value_raw to get_raw_default_value -cci_cfg: add originator to get_raw_value to fix pre/post read callback -cci_param_typed: fix NULL password case -cci_param_typed: fix column width -examples/ex06: fix example with new API -cci_param_typed: fix pre write nested callback lock -dev_examples/gs_example: update to the new API -dev_examples/callback_example: catch bad cci_value during parameter c -cci_param_untyped: fix destruction for partially constructed params -examples/ex07: partial fix -cci_cfg: add get_default_cci_value() -cci_cfg: remove GS dependency - -Oct 31, 2016 -src: move cci_core_types.h to cci_core - -Oct 29, 2016 -Merge pull request #129 from /Updates-on-ex21 -Merge pull request #128 from guyguy333/239-example-param-outside-sysc -Ex06 logfile(s) updated to reflect addition of colliding submodule in -Merge branch '239-example-param-outside-sysc' of https://github.com/g - -Oct 28, 2016 -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #126 from /callback_ex_updates -Merge branch '-callback_ex_updates' -Merge branch 'callback_ex_updates' of https://github.com//cci -Merge pull request #125 from guyguy333/237-datatype-cleanup -Merge branch 'guyguy333-236-mutability-getter' -Merge branch '236-mutability-getter' of https://github.com/guyguy333/cci -Merge for PR#124. -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #123 from guyguy333/235-systemc-2-3-1-support -Update greencontrol submodule reference. -Make submodule public in accordance with common guidelines. -Ex06 expected results for kernels older than 2.3.2. -Merge branch 'guyguy333-235-systemc-2-3-1-support' -Merge branch '235-systemc-2-3-1-support' of https://github.com/guyguy -Merge pull request #122 from guyguy333/234-remove-m-latest-write -Update gs_broker submodule reference. - -Oct 26, 2016 -Added ex21 project file to cci.sln, removed cciparamimpl.lib from cci - -Oct 24, 2016 -examples/ex06: add parameters outside the SystemC hierarchy -cci_param_untyped_handle: fix case original name is NULL - -Oct 15, 2016 -update result -cb update -callback update -../../dev_examples/cb_new_param/ObserverModule.h -minor adjust -add dummy_handle -minor update - -Oct 14, 2016 -cci_datatypes: split into cci_core_types.h and cci_mutable_types.h -prefix cci data type and move to upper-case -cci_datatypes: fix doxygen comment width -cci_datatypes: fix indentation and extra whitespaces -prefix parameter mutable type and move to upper-case -cci_cfg: add mutable type getter -update const function -cci_param_untyped_handle: avoid documentation duplication -examples/ex06: add a conflict name test with SystemC hierarchy -cci_cfg+cci_core: add SystemC 2.3.1 support for name collision avoidance - -Oct 13, 2016 -example updates -nested callback prevention -add param handle to event and add nested callback prevention -add param handle to event -cci_cfg: remove cci_param_untyped::m_latest_write_access_originator_v - -Oct 12, 2016 -Merge pull request #121 from guyguy333/156-fix-license-header -Merge pull request #120 from guyguy333/hotfix-oct-12 -Update MSVS cciapi project file with files added/deleted for callbacks. -license: consistently apply the new Apache2 aligned license header -clean: remove uneeded files -packages: update gs module references -scripts: update regression summary -cci_param_untyped: restore code deleted in last merge -Update gs_broker submodule reference. -Merge branch 'guyguy333-148-callbacks' -Merge branch '148-callbacks' of https://github.com/guyguy333/cci into - -Merge pull request #98 from guyguy333/146-destructed-parameters-acces -Update regression summary with addition of Ex#21. -Update greensocs submodule references. -Merge branch '146-destructed-parameters-accessor-rebase' of https://g -cci_core: rename cci_config.h to cci_cmnhdr.h -dev_examples/callback_standalone: update to latest callback API -cci_param_untyped: fix callback originator check -cci_originator: add operator== -cci_originator: fix string_name in case it's not defined -cci_cfg: add post_read callback -cci_cfg: update callback API name -cci_broker_if: clean -cci_broker_if: fix indentation -cci_broker_if: fix build with clang -cci_param: improve readability/maintainability -cci_param: simplify unregister callback API -cci_param_typed: add note about default value -cci_param: fix value_type -cci_param: fix documentation -cci_param_callbacks: remove duplicate -cci_param_handle: add read callback support -cci_param: fix typed handle ambiguity -cci_param: global callback fix typed/untyped tag -cci_param_callbacks: add cci_param_write_event_untyped and cci_param_ -cci_param: improve read callback API -cci_param: improve write / validate write callback API -cci_param_untyped: fix fixed type param callback -cci_param_typed: group related callback methods -cci_param_typed: remove uneeded explicit namespace -cci_param_typed: remove duplicated code -cci_param_typed: run write callback after actual write and validation -cci_param_typed: remove uneeded cast -cci_param_typed: pass value by reference -cci_param_typed: replace T by value_type -cci_broker_if: add cci_broker_callback_if inheritance -cci_cfg: add more convenient callback registration methods -cci_cfg: create_param_handle returns by value -cci_param_typed: fix write callback with pwd -cci_cfg: add read callback -examples/ex19: add support for new cci_param_if API -examples/ex21: move to the new Apache header -cci_cfg: add parameter destruction / resurrection support - -Sep 28, 2016 -cci_cfg: add write callbacks -cci_cfg: fix indentation -cci_broker_if: fix missing header -callbacks: documantation fixes, small example cleanups -Initial callback proposal - not yet integrated -fixup compilation errors -cci_cfg: drop Boost dependency -cci_cfg: remove old callback version -Modified cci_param classes to use new API interfaces -Added CCI_MOVE macro to help with move semantics -Added cci_callback support for a single parameter -Adding callback wrapper class -Adding handle class for callback registrations -Adding check for rvalue compiler support (continually enable move sem - -Sep 23, 2016 -Merge pull request #109 from /administrative_items -Add guidlines for enum naming and doxygen @copydoc. - -Sep 15, 2016 -Merge branch 'guyguy333-138-top-level-parameter' -Direct example output into a dedicated directory to avoid cross-examp -Update greencontrol submodule reference. -Merge branch '-Built-projects-of-examples-for-cci' -Merge branch 'Built-projects-of-examples-for-cci' of https://github.c -Change CCI_TOP_LEVEL_NAME to CCI_ABSOLUTE_NAME in a few lingering exa -Merge pull request #104 from /Updated-README-and-Instructi -Merge branch '138-top-level-parameter' of https://github.com/guyguy33 -Built projects of examples and included all projects in sln file of cci -Merge pull request #101 from guyguy333/136-cci-name-gen -cci_cfg/cci_param_typed: replace cci_top_level_name with cci_name_type -Add guideline for naming include guard macros. -The NOTICE file in support of the Apache License, Version 2.0; this c - -Sep 14, 2016 -Changed the path syntax to avoid confusion -cci_cfg/cci_param_typed: add documentation of constructors -cci_cfg/cci_param_typed: remove confusion in constructors -cci_param_typed: add originator as an optional constructor argument -cci_param_typed: remove unused constructors -examples/ex06_Parameter_Naming: fix golden file -dev_examples/priv_broker_example: fix golden file -scripts/verify.pl: add SC_INCLUDE_DYNAMIC_PROCESSES for GreenControl -Update MSVS project to reflect renamed class and new source file. -cci_name_gen: use SystemC registry name -Updated all README and Instructions in CCI - -Sep 13, 2016 -Merge branch '138-top-level-parameter' of https://github.com/guyguy33 - -Sep 12, 2016 -Merge pull request #103 from guyguy333/fix-gs-reference -Regression summary with expected failures (11) due to callbacks rework. -Merge branch 'fix-gs-reference' of https://github.com/guyguy333/cci i -packages/gs_broker: update reference - -Sep 8, 2016 -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #94 from guyguy333/217-fix-global-broker-originator -Merge branch 'guyguy333-217-fix-global-broker-originator' -Set gs_broker submodule ref to 217-fix-global-broker-originator branch. -Merge branch '217-fix-global-broker-originator' of https://github.com -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #96 from guyguy333/218-handle-by-value -Merge branch 'guyguy333-218-handle-by-value' -Set gs_broker ref to 218-handle-by-value branch. -cci_param_typed: add originator as an optional constructor argument -cci_param_typed: remove unused constructors - -Sep 7, 2016 -cci_originator: refactoring and simplification - -Sep 6, 2016 -Merge pull request #17 from /intel-feature-msvc14 - -Sep 5, 2016 -cci_originator: remove constructor with pointer to module/object -cci_originator: improve name constructor doc -cci_originator: group constructors -cci_originator: move to cpp -cci_originator: remove non-standard code -cci_originator: add cci_originator constructor with rescue name -cci_param_untyped_handle: move constructor to public -cci_param_untyped_handle: mark invalid constructor as explicit -examples/dev_examples: update examples with handle returned by value -cci_param_typed: fix get_default_value() -cci_cfg: remove is_handle() -cci_cfg: return param handle by value - -Sep 3, 2016 -Remove cci_factory.h which is no longer relevant from the cciapi proj -Merge branch '-Baseline-MSVS-2010-for-cci' -Merge branch 'Baseline-MSVS-2010-for-cci' of https://github.com/sonal -Merge pull request #97 from guyguy333/151-metadata -Add new metadata support in example param implementation of ex19 to g - -Sep 2, 2016 -Merge branch '151-metadata' of https://github.com/guyguy333/cci into -Reconcile 2 dev_examples with recent json API updates, restoring them -Merge branch 'guyguy333-gs-ref-09-01' - -Sep 1, 2016 -packages: update greencontrol and gs_broker references -cci_param_typed: check init value is not null first -cci_cfg: add metadata support -Merge pull request #77 from guyguy333/147-serialization-cci-value -cci_broker_if: set get_cci_value_keep_unused as a const method -cci_cfg: remove JSON comments -examples/ex19: update to latest CCI API -cci_broker_if: align API with cci_value -cci_value: clean serialization / deserialization API -move serialization / deserialization from cci_param_if to cci_value -dev_examples/gs_example: fix golden file - -Aug 25, 2016 -Merge pull request #95 from guyguy333/141-broker-api-init -Merge pull request #84 from guyguy333/137-cci-report-handler -Merge pull request #93 from guyguy333/216-protect-raw-value -Document Updated as msvc10 migration - -Aug 19, 2016 -Migration from msvc80 to msvc10 with VS2010 as baseline - -Aug 18, 2016 -cci_param_typed: initialize value in case an initial value is available -cci_broker_if: add get_initial_cci_value -dev_examples/cci_hierarchical_values_set: update golden log -cci_macros: remove unused macro -cci_macros: enable cci_report_handler macros outside of CCI -cci_report_handler: more generic prefix -cci_report_handler: only throw in case of severity >= error -cci_cfg: replace SC_REPORT_* with CCI_REPORT_* -cci_report_handler: fix macros -cci_param_if: protect raw getters -Merge branch '-example_updates' (PR91 and PR92). -Merge pull request #91 from guyguy333/fix-overload -Visual Studio and verify.pl updates due to refactoring. - -Aug 17, 2016 -cci_param_typed_handle: add more convenient operators "=" -cci_param_typed: add convenient operators "=" -cci_param_untyped_handle: remove unused code -cci_cfg: add operator= overload -cci_cfg: add equals overload -update for merge #91 with newly added virtual functions -bugfix for cci_param - -Aug 16, 2016 -examples fixes -bugfix for cci_param -cci_cfg: add operator= overload -cci_cfg: add equals overload - -Aug 15, 2016 -Merge pull request #90 from guyguy333/174-cci-param-refactoring - -Aug 12, 2016 -implement the new CCI architecture - -Aug 9, 2016 -Merge pull request #89 from /verify-up -recover the fix for windows CRLF - -Aug 4, 2016 -verify.pl: Add support for MSVC 2015 - -Jul 26, 2016 -add a header 'SystemC Simulation' in golden reference to keep consist -merged from systemc-regressions/verify-pl - -Jul 13, 2016 -packages: fix gs submodule references - -Jul 12, 2016 -Merge pull request #87 from guyguy333/177-refactor-repository - -Jul 8, 2016 -src: fix license alignement -src: update license to Apache 2 (donation) -dev_examples: update license to Apache 2 (donation) -gs_param: move to GreenSocs forge -gs_broker: move to GreenSocs forge -greencontrol: move to GreenSocs forge - -Jul 7, 2016 -Merge pull request #82 from /46_param_desc_ctr - -Jul 6, 2016 -remove cci_param.hpp which is not used anymore -add Apache legal header -adding copyright - -Jun 27, 2016 -add copyright -Merge pull request #85 from /msvs2015_support - -Jun 16, 2016 -Project files updated to match the source files -Fixes and instruction for MSVS2015 - -Jun 8, 2016 -add comments -remove default for definition -add parameter description into parameter creation -add parameter 'description' to constructor with default value to empt -replace 'documentation' by 'description' - -Jun 7, 2016 -Revert "Adding function to get initial value till broker" -Revert "minor cleanup for setInitialVal" -Revert "add initial value check and set in the param constructor" -Revert "remove initial value update from broker" -add initial value check and set in the param constructor -remove initial value update from broker -revert changes to example - -Jun 6, 2016 -Support for VS2015 and Removal of Carriage return - -Jun 1, 2016 -minor cleanup for setInitialVal -Adding function to get initial value till broker - -May 31, 2016 -Adding function to get initial value till broker - -Apr 5, 2016 -Merge pull request #12 from /intel-feature-win-dll - -Dec 1, 2015 -Merge pull request #9 from DAarno/linux-4 - -Nov 22, 2015 -verify.pl: allow linking against SystemC DLL (Windows/MSVC only) -verify.pl: typo fixes in usage output (missing periods) -verify.pl: updates for MSVC - -Nov 18, 2015 -verify.pl: inherit TLM_HOME if unset - -Oct 19, 2015 -Drop the check for linux kernel version as suggested by multiple revi - -Oct 16, 2015 -Add support for running on Linux with kernel versions 4.x. - -Oct 7, 2015 -Update instructions to reflect reorganized directories. -Updated regressions results; all examples now passing. - - -Oct 7, 2015 -Merge Ex06 fixes. -Fix cci_gen_unique_name returning pointer to stack variable bug. -Add ericsson copyright - -Sep 29, 2015 -update test numbers and add Author - -Sep 17, 2015 -uncommented out the assert for same name parameter due to collision i -use cci_gen_unique_name for parameter name collision -update the log -add setting and reading for parameter with name update -uplift from osci-wg/master for latest fix - -Sep 14, 2015 -Merge pull request #65 from /coding_guidelines - -Sep 9, 2015 -Merge pull request #64 from /fix_regressions - -Sep 2, 2015 -Combine and update coding guidelines - -Sep 1, 2015 -Expected regression results; only Ex06 failing -Windows and Linux results are now the same -Use boost random for consistent results across Win & Linux. -Fix this-> and namespaces for Linux compilation. -Expected Windows regression results (only Ex06 failing) -Cross-platform improved Ex09 golden log -Remove tab formatting in Ex09 -Seed rand() for repeatable results across Win/Linux. -Replace __FUNCTION__ in Ex19 for platform independent results -Merge master into fix_regressions. -Update MSVS property sheet for private broker build -Scope all params to modules - -Aug 28, 2015 -Merge pull request #63 from /parameter_ownership - -Aug 25, 2015 -Update MSVS property sheet for private broker build -Fix priv_broker dev_example header names -Expected regression test results (win). -Scope all params to modules -Updates results from value originator fix -Scope all params to modules -Scope all params to modules -Fix syntax error (placement of SC_HAS_PROCESS macro). -Scope all params to modules -Improve unowned parameter error reporting - -Aug 24, 2015 -Updated regression results (Linux). -Fix this-> and namespaces for Linux compilation. -Update instructions to reflect directory restructuring. - -Aug 21, 2015 -Fix cb_new_param dev_example -Expected regression test results (win). -Scope all params to modules -Updates results from value originator fix -Scope all params to modules -Scope all params to modules -Fix syntax error (placement of SC_HAS_PROCESS macro). - -Aug 20, 2015 -Scope all params to modules -Improve unowned parameter error reporting -Remove Ex06 parameters created outside of module context. -Merge branch 'ex06_update' of https://github.com//cci into -Merge branch 'master' of https://github.com/OSCI-WG/cci -Merge pull request #51 from /doxygen - -Aug 19, 2015 -Adjust source path based on directory restructuring. -Merge branch '-doxygen' -Merge branch 'doxygen' of https://github.com//cci into -d -Merge pull request #62 from /ex03ex04_updates -Manual merge of PR50 (-ex03ex04_updates) - -Aug 17, 2015 -Merge pull request #61 from /-hire_value_ex -Merge pull request #60 from /namespace -Add Property Sheets for MSVC 10+ -Adjust for namespace & class name changes. - -Aug 5, 2015 -Merge branch 'hire_value_ex' of https://github.com//cci int -Comments for true pImpl refactoring updated. - -Aug 4, 2015 -Add expected regression results for Windows. -Update .gitignore patterns - -Aug 1, 2015 -Initial originator handling - -Jul 29, 2015 -Remove notion of invalid value. - -Jul 28, 2015 -ex19 updated golden log - -Jul 20, 2015 -dev example fixes for namespace/directory changes -linux build tweak -Updating Linux Makefiles - -Jul 16, 2015 -ex16,17,18,19,20 updates -ex13,14,15 updates -ex10,11,12 updates -ex07,08,09 updates -ex04, 05, 06 updates -ex04 updates -ex03 updates -removed cnf from used classes -removed cnf from class names and header guards -update to ex02 -update to ex01 -updating verify.pl to pull from correct directory -fixing missed namespaces -api and implementation source update for new directory structure -update VS proj files -changing top-level header cci to cci_configuration -chaning cci_cnf to cci_cfg -renaming api to src - -May 27, 2015 -assertion for adding parameters with same name is commented out. Gold - -May 9, 2015 -Replace macro expansion of cci_param constructor arguments with expan -Fixing copyright headers - -May 6, 2015 -Added missing include for SystemC installation -Fixing SC_MODULE macro issue in Doxygen documentation - -Apr 30, 2015 -refactor -removed wrong merged file -code styple updates -uplifted for ex03 -updated from master -minor changes for code style -Doxygen documentation and whitespace cleanup -Adding missing files to msvc80 projects - -Apr 27, 2015 -minor changes for ex -add hierarchical values set example - -Apr 25, 2015 -Resolves issue #35, #36, and partially #29. - -Apr 23, 2015 -Merge pull request #45 from /example_documentation_cleanup -Merge pull request #43 from /master - -Apr 10, 2015 -TI copyright headers -ex20 doxygen comments -ex20 copyright -ex19 doxygen comments - -Apr 9, 2015 -ex19 copyrights -ex18 doxygen comments + minor touchups to ex17 -ex18 copyrights -ex17 doxygen comments - -Apr 3, 2015 -Documentation clarifications related to windows build. -Reference for coding style; just an initial starting point for now. - -Apr 2, 2015 -ex17 copyright headers -ex16 doxygen comments -ex16 copyright headers -ex15 doxygen comments -ex15 copyright headers - -Mar 31, 2015 -ex14 doxygen comments -ex14 copyright headers -ex13 doxygen comments -ex13 copyright headers -ex12 doxygen comments - -Mar 30, 2015 -ex12 copyright headers -ex11 doxygen comments -ex11 copyright headers -ex10 doxygen comments -ex10 copyright header -ex09 doxygen comments -ex09 copyright header -ex08 doxygen comments -ex07 doxygen comments -ex07 copyright header -doxygen comments for ex06 -doxygen comments for ex05 - -Mar 27, 2015 -doxygen comments for example04 + small changes in prvious commits - -Mar 26, 2015 -doxygen comments for example 03 + slight changes to ex02 -doxygen comments for example 02 -doxygen comments for example 01 - -Mar 22, 2015 -Merge pull request #40 from /intel-cci_value-serialize-msvc80 - -Mar 21, 2015 -update copyrights - -Mar 19, 2015 -cci_value: move template push_(back,entry) functions - -Feb 19, 2015 -cci_value_traits: add 'const T[N]' overload -cci_value_traits: use "extern" for explicit template instantiation -cci_value_traits_convert: explicit cast between converted types -cci_value(_traits): fix some warnings on MSVC -Update RapidJSON submodule - -Feb 18, 2015 -cci_value_traits.h: some fixed point fixes -/Makefile: add -DSC_INCLUDE_FX - -Feb 6, 2015 -msvc80/../cciapi.vcproj: update for cci_value serialization -Merge branch 'offis-serialize-cci_value-examples' -Merge branch 'offis-ericsson-msvc80' -Merge branch 'offis-cleanup-examples' -Merge branch 'offis-sync-verify.pl' - -Feb 5, 2015 -ex03 golded file updated -ex03 ex04 updates with logic functions added for immutable para and e - -Dec 30, 2014 -msvc80/cci/README.txt: update instructions -msvc80/cci/README.txt: add instructions -msvc80: drop boiler-plate ReadMe.txt files -add example property sheet -cciparamimpl.vcproj: disable warning 4250 -greencontrol: drop nested struct in inline function -greencontrol: drop exception specification -systemc.h: hide warnings on MSVC -*.vcproj: update MSVC project files to use new property sheet -cci_lib.vsprops: update MSVC property sheet -updated before park task -msvc80 projects and solution -msvc80 projects and solution -Merge branch 'offis-sync-verify.pl' into offis-ericsson-msvc80 -ex20: use `double` instead of `float` -ex19: add `const` to `get_value` -ex17: use JSON properly -ex16: fix user-defined data type example -GreenControl: allow trailing whitespace after stream extraction -ex13: update golden log -ex12: use cci_value instead of JSON for value access -ex09: don't use JSON -ex07: update to new cci_value behaviour -cci_value_example: update golden log -Merge branch 'offis-cleanup-examples' into offis-serialize-cci_value- -ex19: avoid uint(64,32)_t -ex15: avoid std::pow ambiguity -ex09: avoid master/slave naming -examples: add missing namespace qualifications -examples: simplify includes -Merge branch 'offis-sync-verify.pl' into offis-cleanup-examples -verify.pl: guess CCI_HOME from script location - -Dec 29, 2014 -verify.pl: allow running all tests via '.' -verify.pl: add CCI-specific local include directory -verify.pl: allow running all tests via '.' -cci_value::get_bool(): add missing assert (typo) - -Dec 23, 2014 -cci_value: add std::(i|o)stream extraction/insertion -rapidjson.h: add std::basic_(i|o)stream wrappers -cci_value::set_int64(): fix copy&paste error -cci_param::get_value: add missing const - -Dec 22, 2014 -verify.pl: explicitly add test dir to include path -verify.pl: explicitly add test dir to include path - -Dec 17, 2014 -Merge pull request #17 from /example_cleanup - -Dec 10, 2014 -remove ./ from includes -merge with CCI master - -Dec 2, 2014 -cci_value_list: add capacity/reserve -cci_value(_traits): update documentation - -Dec 1, 2014 -verify.pl: really ignore non-existent library paths - -Nov 30, 2014 -Merge branch 'master' into offis-sync-verify.pl -/Makefile: put libraries in $CCI_HOME/lib -verify.pl: assume library locations as defined in #18 -verify.pl: add support for optional local part on MSVC -verify.pl: improve library path handling -Makefiles: add dependency handling, cleanups -xerify.pl: add support for optional local part on MSVC -verify.pl: improve library path handling -cci_doxygen_api_ref.conf: explicitly expand namespace macros -api: prefix local includes with path (see #19, 20) -api/cci: include cci_version.h -RapidJSON: parse floating point numbers at full precision - -Nov 28, 2014 -RapidJSON: update to current 'master' - -Nov 27, 2014 -RapidJSON submodule: prefer https:// over git:// -dev_examples: adjust tests to new cci_value implementation -scripts/verify.pl: reorder libs to follow changed dependencies -api/cci: include cci_value(_traits).h -gs_cci_param.h: switch to new cci_value implementation -cci_value: (temporarily) add output stream operator -cci_value: warn on JSON errors -cci_value: add get/set_number() as alias for get/set_double() -cci_value: allow double conversions -drop json_spirit -helpfunctions.h: drop empty file -dev_example/cci_value_simple: extended -cci_value_traits: add basic support for sc_time -cci_value_traits: add basic support for SystemC datatypes -dev_examples/cci_value_simple: test std::vector[] -cci_value_traits: add std::vector support -cci_value: add traits SFINAE to template functions -dev_examples/cci_value_simple: extended map example -cci_value(_list,_map): add implementation -cci_value: add simple map interface (wip) -dev_examples/cci_value_simple: extended list example -cci_value_traits: add support for C/C++ arrays -cci_value: add simple list interface (wip) -dev_examples/cci_value_simple: add string example -cci_value_traits: add string support -cci_value: add string implementation -dev_examples/cci_value_simple: add example for new cci_value -cci_value: add comparison -cci_value.h: add templated get/set, initial traits -cci_value.cpp: add initial implementation -cci_value.cpp: drop old implementation -cci_value: initial version of reimplementation (wip) -api/Makefile: add RapidJSON -cci_cnf/rapidjson.h: add (internal) RapidJSON header -cci_report_handler: allow forwarding of __FILE__, __LINE__ -cci_value: drop old code -add RapidJSON submodule - -Nov 25, 2014 -define SC_ENABLE_ASSERTIONS during the build - -Nov 22, 2014 -Merge pull request #20 from /offis-cleanup-api - -Nov 7, 2014 -add basic cci_version.h -systemc.h: add sc_get_current_object for SystemC < 2.3.1 -systemc.h: add SystemC version checks -add license/documentation to systemc.h -examples: fix includes -gs_broker_implementation: adjust to new API headers -rename namespace macros -api/cci: adjust include paths -api: move param originator to library -api: disentangle headers -cci_report_handler: add include guards and (old) license -update include guard naming scheme -drop unused broker registry -api: moved files to cci_core, cci_cnf -Makefiles: add dependency handling, cleanups - -Nov 6, 2014 -.gitignore: cleanup and comments - -Oct 30, 2014 -Major example overhaul. Consistent filenames, coding style consistent - -Oct 10, 2014 -Merge pull request #14 from /offis-cleanup-misc -Merge pull request #13 from /offis-fix-boost_gcc -Merge pull request #12 from /verify-pl - -Oct 8, 2014 -SYSTEMC_CHECK_ASSERT -> SC_ENABLE_ASSERTIONS -define SYSTEMC_CHECK_ASSERT during the build - -May 18, 2014 -cci_callbacks.hpp: fix get_name/name inconsistency -cci_value_example: ignore deprecation warning -move regression_tests/cb_new_param to dev_examples -drop obsolete test code - -May 17, 2014 -drop duplication of (old) examples -drop spurious VIM swap file - -Apr 30, 2014 -Suppress 'unused template' warnings emitted by GCC 4.8 onwards -verify.pl: fix regex in BSD arch detection -verify.pl: fix regex in BSD arch detection - -Apr 22, 2014 -scripts/: add vsvars.bat to simplify Visual C++ setup -verify.pl: add MSVC'2013 -verify.pl: add missing rt_ldrpath for sparcOS5 - -Apr 17, 2014 -Merge branch 'master' into release -scripts/: add vsvars.bat to simplify Visual C++ setup - -Apr 16, 2014 -verify.pl: add MSVC'2013 - -Feb 13, 2014 -Suppressed 'initialisation re-ordering' warnings from greencontrol code -Suppressed 'Unused variable' warnings from greencontrol code -Suppress 'unused template' warnings emitted by GCC 4.8 onwards -Suppress 'unused template' warnings emitted by GCC 4.8 onwards -Fix boost/spirit compile errors - -Feb 7, 2014 -Merge branch 'master' into release - -Feb 5, 2014 -verify.pl: add missing rt_ldrpath for sparcOS5 - -Jan 26, 2014 -verify.pl: update copyright headers -verify.pl: add -recheck option -verify.pl: accept -D,-I,-L,-l args without spaces -verify.pl: accept all GCC-compatible compilers -verify.pl: complete support for new BSD arch name -verify.pl: add support for additional linker options -verify.pl: fugbix typo -verify.pl: add support for arch restrictions - -Jan 24, 2014 -Merge pull request #11 from /master -Add WG member instructions for including dev_examples in regression t - -Dec 15, 2013 -Merge branch 'master-2.3.1' into release-2.3.1 -update copyright headers - -Dec 4, 2013 -verify.pl: add -recheck option - -Nov 27, 2013 -verify.pl: accept -D,-I,-L,-l args without spaces - -Nov 24, 2013 -verify.pl: accept all GCC-compatible compilers -complete support for new BSD arch name -verify.pl: add support for additional linker options - -Nov 3, 2013 -verify.pl: fugbix typo - -Oct 25, 2013 -Merge pull request #10 from /master -Add instructional documents to aid examples reviews. - -Oct 23, 2013 -Rename example-specific files (and classes) to be unique. -Add doxygen configuration file for examples and update top-level READ -Add/update legal headers. -Correct copy/past carryover comments. - -Oct 18, 2013 -A Makefile wrapper for the build script; primarily to ease Eclipse in - -Oct 9, 2013 -Merge pull request #9 from /master -Update README files and regression summary to reflect inclusion of de - -Oct 4, 2013 -verify.pl: add support for arch restrictions - -Sep 27, 2013 -dev_examples: prepare for regression script -verify.pl: add support for additional defines (-D) -verify.pl: add support for additional defines (-D) -verify.pl: add support for additional includes (-I) -verify.pl: store library environment overrides in arrays -verify.pl: add support for additional includes (-I) -verify.pl: store library environment overrides in arrays -verify.pl: fixup CCI comment typos -Rename test source and golden log files uniquely (vs. main). - -Sep 24, 2013 -Rename examples directories for consistency and correspondingly updat - -Sep 15, 2013 -verify.pl: let user specify test directory (SYSTEMC_TEST) -verify.pl: strip "SystemC Simulation" from golden logs -verify.pl: add CCI-specific include paths and libraries -verify.pl: (re-)add CCI_HOME, BOOST_HOME -verify.pl: add support for common include directory -verify.pl: add support for common include directory -verify.pl: whitespace cleanups -verify.pl: only add test-specific include directory, if it exists -verify.pl: cleanup path and library handling -verify.pl: support BusyBox diff, MobaXterm environment (Windows) -verify.pl: add support for MSVC++ 64-bit (cross-)compiler -improve MacOS X 64-bit arch detection -verify.pl: drop ${slash} hack on Windows -verify.pl: add initial support for MSVC 2011/2012 -verify.pl: fixup some arch matches -user-overridden SystemC architecture -re-order include directories -Detect more reliably 64 bit architecture on Mac OS X -cleanup empty directories recursively -verify.pl: revert to latest LWG version -verify.pl: whitespace cleanups -verify.pl: only add test-specific include directory, if it exists -verify.pl: cleanup path and library handling - -Sep 14, 2013 -Updated readme, moved some files in script folder to old-doc -verify.pl: support BusyBox diff, MobaXterm environment (Windows) -verify.pl: add support for MSVC++ 64-bit (cross-)compiler -improve MacOS X 64-bit arch detection -verify.pl: drop ${slash} hack on Windows -verify.pl: add initial support for MSVC 2011/2012 -verify.pl: fixup some arch matches -user-overridden SystemC architecture -re-order include directories -Detect more reliably 64 bit architecture on Mac OS X -cleanup empty directories recursively - -Aug 30, 2013 -Added run folder -SystemC-verification script used for CCI examples, - -Jun 22, 2013 -Merge branch 'release-old' into release - -May 8, 2013 -Merge pull request #7 from /master -Cleanup for better naming consistency; this partially addresses issue 1. - -May 1, 2013 -Remove ; this closes #4. - -Apr 29, 2013 -Remove (char *) alternative forms of (const std::string &); also pref - -Apr 24, 2013 -Update cpp files to use C++ standard style cci header, . -Create and use C++ standard style header, . - -Apr 23, 2013 -Update builds for consistency. - -Mar 8, 2013 -Corrected git URL - -Nov 2, 2012 -Add Makefile support for BOOST_HOME. - -Sep 5, 2012 -dev_examples: add simple recursing Makefile -cleanup "main" example Makefile -initialize pointer members to avoid segfault -cleanup example Makefiles -cleanup Makefiles -examples: drop -DNDEBUG, fix assertions -example: API fixes -GreenControl: port to SystemC 2.3.0 -move cci_value to API library -make cci_gen_unique_name inline -add basic .gitignore -remove Makefile.deps -examples/build-unix/Makefile*: file line endings - -Jul 4, 2012 -Imported systemc_tests-2.3.0_pub_rev_20120610 -Imported systemc_tests-2.3.0_pub_rev_20120511 - -Jun 10, 2012 -Remove shebang line from scripts/verify.pl to make the script run als - -Jun 6, 2012 -Merge remote-tracking branch 'alan/master' into offis/master -verify.pl: drop hashbang line to support arbitrary perl locations again - -May 23, 2012 -Updated instructions for running regressions on Windows using Cygwin - -May 4, 2012 -rename Mac OS X archs again -Take into account new architecture macosxx86_64 - -May 2, 2012 -Fix the annoying Perl warning "$* is no longer supported at ../script - -Mar 29, 2012 -verify.pl: look at TLM_HOME first -Merge remote-tracking branch 'apfitch/master' into 2.3-pub_rev-tlm - -Mar 15, 2012 -Modified verify.pl includes for Microsoft Windows -Updated verify.pl to make TLM_HOME optional. - -Feb 23, 2012 -verify.pl: correctly trim whitespace from filenames - -Feb 22, 2012 -Added Philipp Hartmann's patch to cope with dos line endings in .f files - -Feb 21, 2012 -Updated README/RELEASENOTES etc. -Removed duplicate script directories. Updated README.txt for Windows. -Modified common include structure, using Philipp Hartmann's patch. - -Feb 3, 2012 -reorganise common include structure - -Jan 18, 2012 -The modified verify.pl scripts - all are identical. - -Dec 14, 2011 -Update build issue with example 19 -Updating the examples : - -Dec 12, 2011 -enabled comparison of parameters of different mutability (but same type) -- modified == operator (in API headers) -- updated parameter implementations - -Dec 1, 2011 -small broker implementation change to provide compatibility for example #16 - -Nov 14, 2011 -cci_value support for SystemC data types -- added full support for SystemC parameter cci_values and string vector parameters -- updated example and guidelines.txt - -Oct 31, 2011 -cci_value support for standard cci_param data types -- added cci_value_helper template class for cci_value support -- added dev_example/cci_value_example - -Oct 19, 2011 -track initial value originators -- added broker function get_latest_write_originator to interface -- implemented in broker and private broker - -Sep 23, 2011 -persistent access to latest value originator -- API: added cci_base_param::get_latest_write_originator() -- updated README -- POC imp: added get_latest_write_originator() -- added observer-demonstration to dev_examples/gs_example - using global get observer API as well as new parameter observer API - -Sep 22, 2011 -added is_initial_value feature -- added is_initial_value support to prototype -- is_initial_value now const -- added dev_example/is_initial_value_example - -Sep 20, 2011 -- slightly changed callback function in broker if: cci_cnf_broker_if::register_str_callback and cci_cnf_broker_if::register_callback which was not complete yet -- added some callback abilities to prototype in gs_cci_cnf_broker -- added dev_example/callback_example - -Sep 6, 2011 -several small changes to callbacks: -- renamed internal callb_adapt_b -> callb_adapt -- added new callback function type with param name: param_callback_func_ptr -- for consistency renamed callback_func_ptr -> param_callback_func_ptr - -Sep 01, 2011 -- removed totally outdated dev_example priv_broker_example_dl -- changed gs private broker's constructor: does not need originator which is created automatically from owner now - -Jul 26, 2011 -- Changed error reporting - -Jul 20, 2011 -- Changed private broker - Automatic push and pop is done by cci_broker_manager - Important: Semantic of cci_broker_manager did change! -- removed broker registry -- Some copy constructors private -- clean-up of some explicit constructors - -Mar 24, 2011 -- BUG - STILL TODO: PRIVATE BROKER STACK POP! - Currently the pop from broker stack needs to be done manually, - cp. testbenches in dev_examples/priv_broker_example* -- changed way how to access broker accessors -- important API change: - instead of cci::cnf::get_cnf_broker_instance(originator)-> - use now cci::cnf::cci_broker_manager::get_current_broker(originator). -- search_for_broker renamed to get_current_broker -- smaller API changes: - gs_cci_private_broker_accessor now get a reference to the owner (not a pointer) - gs_cci_private_broker now gets a name - parameter constructor new options (e.g. broker without bool top-level-name) -- top-level-names in cci_param constructors not with bool but with cci::cnf::CCI_TOP_LEVEL_NAME - (to avoid ambiguous constructors) - -Feb 23, 2011 -- reverted some originator changes: Originator information now hold within global pointer -- added originator data type combining sc_object and name information -- eased originator handling -- changed syntax for get_cnf_broker_instance: - use cci::cnf::get_cnf_broker_instance(cci::cnf::cci_originator(*this)); - intead of cci::cnf::get_cnf_broker_instance(this); -- bugfix reported by Swami in gs_cci_base_param::is_invalid_value - -Feb 1, 2011 -- detach cci_param_(base_)impl_if from cci_(base_)param -- added originator function parameters to cci_param_(base_)impl_if and example implementation - (still TODO for most functions) -- modified cci_(base_)param so that they now can create a copy of themselved, with storing originator information, to act as parameter accessors -- changed broker interface (rules) and implementation to use param accessors -TODO: Tests + further functions in cci_param_(base_)impl_if and implementation - -Dec 15, 2010 -- Added to broker implementation: - - broker accessors: - originator information is transfered over internal GreenControl - infratructure thus it can be logged. - - still TODO: parameter accessors - -Nov 10, 2010 -- API modification: - changed originator information in global get_cnf_broker_instance function: - - Changed sc_module to sc_object - - Added function getting string - - Added end-user rules - - not yet implemented - -Oct 21, 2010 -- library cleanup, new rules -- gs_example_diff_impl updated - -Oct 19, 2010 -- big clean-up -- libraries (param and broker implementations) are now really independent -- examples clean-up -- param implementation library prepared to contain symbols for the provided functions - -earlier: - -- moved pre_write to reject_write callbacks and - added pre_write callbacks - -- hotfixed callback deletion issue -- fixed warnings and modified gs param implementation constructors -- modified internal cci report class - -- added broker function get_json_string_keep_unused - -- added get_default_value to cci_param interface -- added cci_param constructors (eliminating optional function parameters) -- underlying gs_param: - - added default value - - added is_used status (and get not impacting that status) - - added internal init value locked check - -- moved license to own file (not changed the license) -- added hierarchical precendence support by -- adding lock to initial values - -- added cci_param constructor with implementation pointer -- changed global static factory function names and namespaces -- changed broker.add_param to be called by cci_header class -- added optional broker parameter to param constructors -- separated header from implementation into different files -- introduced new path substructure in api path -- introduced cci::cnf namespace -- changed cci.h to be main include file and -- made cci_config.h the config part include file -- renamed cci_broker_module into cci_broker_manager and added convenience cci_broker_manager_module (deriving from sc_module) -- renamed cnf_api to cnf_broker - -**** CCI-1.31-cci_api-160310.tar.gz **** - -- Pimpl idiom / Opaque Pointer concept for params -- removed boost version dependency of implementation -- replaced boost int64 with SystemC int64 -- replaced boost shared_ptr and function -- private Broker API and example - - -**** CCI-1.3-cci_api-240210.tar.gz **** - -- changed param hierarchy to be defined by the document and directly implemented thus being used directly by user (without pure virtual interface) (interfaces are just for compile checks) -- added is_invalid implementation, also for uninitialized params -- added locked status and checks to gs implementation -- added is_used dummy to gs implementation -- changed is_used semantic: also true if there WAS an object mapped to the NVP - -**** CCI-1.21-cci_api-130110.tar.gz **** - -- added syncronize API to base param -- added lock API to base params -- added mutable template types to POs -- added is_used for detecting unconsumed parameters -- added is/set_invalid_value, is_initial_value, is_default_value - - -**** CCI-1.2-101109.tar.gz **** - -- error/warning/info throwing using sc_report mechanism -- added functions for status fields/value origin (is_default_value, is_initial_value, is_invalid_value, set_invalid_value to base param -- added functions set/get_documentation for meta data to base param -- cci_value parameter value representation -- added real number to basic data types -- cci_base_param are objects that can be instantiated. -- renamed cci_param_base to cci_base_param, because it will change from a base class to a param object -- added return type to callbacks (e.g. to support value rejection on pre write callback) -- Changed callback type from function pointer to boost::function. - - -**** CCI-1.1-280509.tar.gz **** - -- Added callback type (reason) to callback function signature -- Error codes as return value instead of bool -- Made basic parameter types JSON independent (just renaming) - to avoid confusion (JSON not necessary here, only needed for - (de)serialize). -- Added notes.txt file. -- Portability: changed long long to sc_dt::uint64 - - -**** CCI-1.0-180509.tar.gz **** - -- initial release - diff --git a/Makefile.am b/Makefile.am index 3e371d43..2c44c5a3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -7,7 +7,6 @@ SUBDIRS = \ DOC_FILES = \ AUTHORS \ - ChangeLog \ INSTALL.md \ LICENSE \ NEWS \ From 9334af65d10558516081b721398b5b69305a6241 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20J=C3=BCnger?= Date: Tue, 8 Aug 2023 16:05:14 +0200 Subject: [PATCH 3/3] Update DEVELOPMENT.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update to DEVELOPMENT.md to reflect the automatic creation of release tarballs through GitHub Actions. Signed-off-by: Lukas Jünger --- docs/DEVELOPMENT.md | 47 ++++++++++++++------------------------------- 1 file changed, 14 insertions(+), 33 deletions(-) diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index a5849f57..4653d9a6 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -290,7 +290,7 @@ performed by the maintainer Before creating a release snapshot, the documentation and version information in the package should be updated within the `master` branch. This includes files like - - `ChangeLog`, `RELEASENOTES`, `README`, `INSTALL` + - `RELEASENOTES`, `README`, `INSTALL`, `configure.ac`, `cci_version.h` - [Version headers](#versioning-scheme) During the release preparation phase, other functional changes @@ -308,17 +308,7 @@ performed by the maintainer git commit -m "merge master branch for x.x.x release" ``` -3. **Update the Autoconf (and other auto-generated) files** - - ``` - autoreconf -if # or config/bootstrap - git add -u # add changed files - git status # check for untracked files - git add - git commit -m "update autogenerated files for x.x.x release" - ``` - -4. **Tag the release revision** +3. **Tag the release revision** In order to keep track of the release snapshots, the revisions used for creating the release tarballs should be marked with an *annotated* @@ -326,37 +316,28 @@ performed by the maintainer ``` # git tag -a -m " " - git tag -a -m "CCI 1.0.1" 1.0.1 release + git tag -a -m "CCI 1.0.1" v1.0.1 release ``` - The tagname should contain the `` in `Major.Minor.Patch` format + The tagname should contain the `` in `vMajor.Minor.Patch` format (see [section Versioning scheme](#versioning-scheme)). Optionally, the following extensions could be added to the release name: - * `x.x.x_rc_` for release candidate (version for Accellera WG internal review) - * `x.x.x_beta_` for beta/internal versions - * `x.x.x_pub_rev_` for public review versions, and - * `x.x.x` for public release versions. + * `vx.x.x_rc_` for release candidate (version for Accellera WG internal review) + * `vx.x.x_beta_` for beta/internal versions + * `vx.x.x_pub_rev_` for public review versions, and + * `vx.x.x` for public release versions. > *NOTE:* The tag should be on the `release` branch, to enable the > automated tarball creation in the next step. -5. **Create the release tarball** - - `git archive` can then be used to create the release tarball. - `git describe` can be used to obtain the correct tarball name - based on the current tag. - - ``` - PACKAGE="`basename $(git rev-parse --show-toplevel)`" # or directly 'cci' - VERSION="`git describe release`" - git archive -o ${PACKAGE}-${VERSION}.tgz \ - --prefix=${PACKAGE}-${VERSION}/ release - ``` +4. **Create the release tarball** - > *NOTE:* Even without a tag, a quick-shot release of the - > release branch can be generated this way. + Pushing a tag starting with a "v" will trigger the automatic creation of a + release tarball through GitHub Actions. This tarball will be pushed to the + CCI GitHub site for download. This includes the generation of the automake + files. -6. **Publish the release** +5. **Publish the release** Upload the archive to the Accellera Working Group workspace for internal review and push the changes to GitHub.