From 9d2f9620ba512e343a3fc929b652ea4b7b7206c8 Mon Sep 17 00:00:00 2001 From: Laszlo Nagy Date: Thu, 10 Sep 2020 22:33:30 +1000 Subject: [PATCH] review installed documents --- CMakeLists.txt | 2 +- .github/CONTRIBUTING.md => CONTRIBUTING.md | 0 ChangeLog.md | 403 --------------------- 3 files changed, 1 insertion(+), 404 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (100%) delete mode 100644 ChangeLog.md diff --git a/CMakeLists.txt b/CMakeLists.txt index 140687d3..8bf96716 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -91,7 +91,7 @@ install( USE_SOURCE_PERMISSIONS ) include(GNUInstallDirs) -install(FILES COPYING README.md ChangeLog.md +install(FILES COPYING README.md INSTALL.md CONTRIBUTING.md CODE_OF_CONDUCT.md DESTINATION ${CMAKE_INSTALL_DOCDIR}) # Set up package from this project diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md diff --git a/ChangeLog.md b/ChangeLog.md deleted file mode 100644 index 8af06095..00000000 --- a/ChangeLog.md +++ /dev/null @@ -1,403 +0,0 @@ -## 2.4.3 (2020-01-26) - -Features: - - Support CUDA compilations (@nweston, #275, #277, #278) - - Better duplicate entry detection (#278) - -## 2.4.2 (2019.08.29) - -Features: - - Support `output` field in the output. (#254, @bofeng17) - - Support Fortran compiler (#201, #241, #253, @rubyzhou2014, @chunhualiao) - - Support filter options (#261, #252, @liugang) - -Bugfixes: - - Fix Cpack problem to create RPM. (#191, @antmak, @reverendhomer) - - -## 2.4.1 (2019.07.30) - -Features: - - Add bash completion (#231, @1ace) - -Bugfixes: - - Fix limitation section in readme (#256, @Manouchehri) - - Fix preprocessor flags (#239, @bdemick) - - -## 2.4.0 (2019.05.12) - -Features: - - `libear.so` write binary file instead of JSON. - -Bugfixes: - - Fix `newlocale` problem (#182, #190, @timblaktu, @3v1n0, @caohaiming, @rbresalier) - - Fix long command line problem (#246, @jmodares) - - Fix help text for parameter `--use-only` (#245, @koutheir) - - -## 2.3.13 (2018.08.30) - -Bugfixes: - - Fix bug introduced in 2.3.12 to fix #211 (#221, @markuspohjoismaki) - - -## 2.3.12 (2018.08.06) - -Bugfixes: - - Accept compiler name version without hyphen separator (#216, @Jehops) - - Keep original compiler name (#211, @TomMD) - - Readme file updates on known issues (#208, @matanster) - - Filter extra compilation if requested (#218, @jkbbwr) - - -## 2.3.11 (2018.01.04) - -Bugfixes: - - Fix CPack RPM problems on CentOS7 (@antmak, #191, #192) - - Change `libear.so` location to `$LIBDIR/bear` to avoid direct linking. (@morxa, #189) - - -## 2.3.10 (2017.12.07) - -Bugfixes: - - Fix MPI wrapper problem (@ffevotte, #193) - - Not crash on invalid execution trace file (@dengste, #195) - - -## 2.3.9 (2017.10.25) - -Bugfixes: - - Fix newlocale problem (@bartlibert, #182) - - -## 2.3.8 (2017.10.16) - -Bugfixes: - - Fix compilation issue against libc 2.26 (@ffuugoo, #176) - - -## 2.3.7 (2017.10.07) - -Features: - - Support OpenMPI compiler wrapper - -Bugfixes: - - Fix multithreading build tools problem. (@TTimo, #173) - - -## 2.3.6 (2017.07.02) - -Bugfixes: - - Fix assert when `--append` mode the file is missing for that entry. - - -## 2.3.5 (2017.05.31) - -Bugfixes: - - Fix 0 length argument bug (@jaelsasser, @nickdesaulniers, #160, #161, #163, #164) - - -## 2.3.4 (2017.04.25) - -Bugfixes: - - Include assembly language file extensions (@RichardsonAlex, @bstaletic, #146) - - -## 2.3.3 (2017.04.25) - -Bugfixes: - - Fix crashes caused by unicode command execution (@cgull, #141, @knowack1, #154) - - -## 2.3.2 (2017.04.24) - -Bugfixes: - - Make Bear work with 32-bit and 64-bit toolchains (@deb0ch, @andrey-desman, @nolange, #134) - - -## 2.3.1 (2017.04.22) - -Bugfixes: - - Fix problem with `make install` (@ilovezfs, #153) - - -## 2.3.0 (2017.04.20) - -Features: - - Rewrite functional test on LLVM `lit`. - - Write intermediate execution report in JSON format. - - Write compilation database with "arguments" instead of "command". - - Write compilation database with relative paths. - -Bugfixes: - - Compiler name can be specified as argument (@JakeFederico, #142) - - Update documentation about OSX SIP workaround (@isotes, #152) - - -## 2.2.1 (2016.10.15) - -Bugfixes: - - Fix spelling mistakes in man page (@sebastinas, #128) - - Fix support multiple compilers (@handrake0724, #136) - -Features: - - Finish writing output when the build was interupted by user. - - Travis-CI runs build against OSX machines - - -## 2.2.0 (2016.06.05) - -Bugfixes: - - Fix spelling mistakes in README file (@sebastinas, #116) - - Fix shell escaping to work with arguments which has space (@timangus, #124) - - -## 2.1.5 (2016.02.16) - -Bugfixes: - - Stop filtering out `-m` options (@joshtriplett, #115) - - Updated man page bugs section (#114) - - -## 2.1.4 (2016.02.14) - -Bugfixes: - - Make paths to sources and include files absolute. (@svenpanne, #111) - - Extend known issues section of documentation (#112, #108, #105, #102) - - -## 2.1.3 (2016.01.13) - -Bugfixes: - - warnings are not filtered from output (@velkyel, #106) - - support universal binaries (32 and 64) on x86 OS X (@DeanoC, #101) - - -## 2.1.2 (2015.10.01) - -Bugfixes: - - Fix escaping quotes for shell too. (@zauguin, #88) - - -## 2.1.1 (2015.08.31) - -Bugfixes: - - Fix iterator next method usage (@drvink, #97) - - -## 2.1.0 (2015.08.08) - -Features: - - Ignore preprocessor flags for dependency generation (@jonthn, #74) - - Exclude irrelevant files names in command (@wweic, #94) - - Support MetaWare toolkit (@twpedersen, #95) - - Use docker build for travis-ci - -Bugfixes: - - Get rid of cmake warnings on osx (@emlai, #90) - - Protect report generation in multithread build systems (@smoofra, #93) - - -## 2.0.4 (2015-06-16) - -Bugfixes: - - - Fix crash when `make -j` runs parallel (@minhyuk, #87) - - -## 2.0.3 (2015-04-04) - -Bugfixes: - - - Fix passing of arguments to `mkdtemp` (@kljohann, #75) - - Empty output when compiler used to link. (@QuaziRandom, #80) - - Bad escape of strings in compilation database. (@jumapico, #81) - - -## 2.0.2 (2015-02-08) - -Bugfixes: - - - Address Sanitizer error fixed. - - Fix some typos in man page (@sebastinas, #72) - - -## 2.0.1 (2015-01-23) - -Bugfixes: - - - Double free problem fixed when descrutor called multiple times. - - -## 2.0 (2015-01-20) - -Features: - - - Rewrite command `bear` from C to Python. - - Simplified build process with a single module for `libear`. - -Bugfixes: - - - Work with empty environment (#69, @YorkZ) - - Filter out redundant entries (#66, @HongxuChen) - - Append to existing compilation database (#63, @p0rnfl4k3s) - -## 1.4.4 (2015-01-09) - -Features: - - - Improve escaping logic (#67, #68, @SpecLad) - - Reword README file to be more english (#64, @libnoon) - - -## 1.4.3 (2014-07-11) - -Features: - - - Automatically generate Debian package dependency list with cpack (#62, @bbannier) - - -## 1.4.2 (2014-05-19) - -Features: - - - cross compilers recognised by bear (@nolange) - - -## 1.4.1 (2014-05-09) - -Bugfixes: - - - fix output entries have c14n file path (#61, @nickhutchinson) - - fix error message on missing config file (#60, @viraptor) - - extend README file based on user feedbacks (#54, #55, #56, #59, @btorpey, @breser, @vguerra) - - -## 1.4 (2014-01-12) - -Bugfixes: - - - fix typo in the README.md (#48, @breser) - - fix typo in the man page (#49, @sebastinas) - - fix cmake file to honor given `CFLAGS` (#50, @sebastinas) - - fix execle causes segfault on 32 bit systems (#51, #52, @breser, @sebastinas) - - -## 1.3 (2013-12-18) - -Features: - - - set empty cancel parameter list as default (#39, #43) - - implement verbose filter message at the end of the run (#41) - -Bugfixes: - - - fix process stops when ctrl-z pressed (#40, @bbannier) - - fix non filtered output option renamed from debug (#44, @mikemccracken) - - fix broken build on OS X (#46, @breser) - - fix documentation (@mlq) - - fix `posix_spawn*` call not implemented (#43, @agentsim, @apoluektov) - - -## 1.2 (2013-10-01) - -Features: - - - dependency file generation compiler calls are _optionally_ filtered (#35, @lonico) - - use config file for compiler call filtering parameters (#38, @lonico, @peti) - -Bugfixes: - - - fix end-to-end test on OS X (#37, @smmckay) - - fix memory leaks detected by static analyser - - -## 1.1 (2013-08-01) - -Features: - - - dependency file generation compiler calls `-M` are filtered (#35, @chrta) - - smaller memory footprint (less allocation, code went for places when it is called) - - add version query to command line - -Bugfixes: - - - fix memory leaks detected by static analyser - - -## 1.0 (2013-06-27) - -Features: - - - change license to GPLv3 - -Bugfixes: - - - fix process synchronization problem (#33, @blowback) - - fix `malloc`, `realloc` usage (#34, @mlq) - - -## 0.5 (2013-06-09) - -Features: - - - use temporary directory for default socket (#29, @sebastinas) - -Bugfixes: - - - fix bashism in test (#27, @sebastinas) - - fix temporary socket dir problem introduce by new code (#31, @lukedirtwalker) - - fix bug introduced by report filtering (#32, @lukedirtwalker) - - -## 0.4 (2013-04-26) - -Features: - - - man page generation is optional (#18, @Sarcasm) - - port to OS X (#24, @breser) - -Bugfixes: - - - fix JSON output on whitespaces (#19) - - fix socket reading problem (#20, @brucestephens) - - improved signal handling (#21) - - build system checks for available `exec` functions (#22) - - -## 0.3 (2013-01-09) - -Features: - - - query known compilers which are play roles in filtering (#10) - - query recognised source file extensions which are filtering (#11) - - man page added (#12) - - pacage generation target added to `cmake` (#15) - -Bugfixes: - - - fix child process termination problem - - test added: build result propagation check - - -## 0.2 (2013-01-01) - -Features: - - - add debug output - -Bugfixes: - - - test added: unit test, end-to-end test and full `exec` family coverage (#4) - - `scons` does pass empty environment to child processes (#9) - - fix `execle` overriding bug (#13) - - fix JSON output (#14) - - -## 0.1 (2012-11-17) - -Features: - - - first working version - - [Travis CI](https://travis-ci.org/rizsotto/Bear) hook set up