From f8f531687c62de7d35334bbefedc7293a1cffc5d Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Sat, 31 Oct 2015 14:45:00 -0600 Subject: [PATCH] Release script improvements. --- .gitignore | 3 + build/tools/bld_chm_exe.bat | 82 ------- build/tools/make-html-docs.sh | 30 --- build/tools/release.bat | 71 +++++++ .../tools/{git-make-release.sh => release.sh} | 31 ++- build/tools/wxwidgets.iss | 6 +- docs/contributing/how-to-release.md | 55 +++-- docs/doxygen/regen.bat | 13 +- docs/readme.txt | 201 ++++++++---------- docs/release.md | 117 ++++++++++ docs/release_binaries.mdwn | 112 ---------- docs/release_files.mdwn | 36 ---- 12 files changed, 340 insertions(+), 417 deletions(-) delete mode 100755 build/tools/bld_chm_exe.bat delete mode 100755 build/tools/make-html-docs.sh create mode 100644 build/tools/release.bat rename build/tools/{git-make-release.sh => release.sh} (63%) create mode 100644 docs/release.md delete mode 100644 docs/release_binaries.mdwn delete mode 100644 docs/release_files.mdwn diff --git a/.gitignore b/.gitignore index 3916a1fbc3..a425c69869 100644 --- a/.gitignore +++ b/.gitignore @@ -114,6 +114,9 @@ /demos/poem/poemM5.mcp /demos/poem/poemM*Data +# /distrib/release/ +/distrib/release + # /docs/doxygen/ /docs/doxygen/doxygen.log /docs/doxygen/out diff --git a/build/tools/bld_chm_exe.bat b/build/tools/bld_chm_exe.bat deleted file mode 100755 index 8bfc238443..0000000000 --- a/build/tools/bld_chm_exe.bat +++ /dev/null @@ -1,82 +0,0 @@ -rem Uncomment the next line to set the version; used also in wxWidgets.iss -SET WXW_VER=3.1.0 -if (%WXW_VER%)==() SET WXW_VER=git - -echo docs building for %WXW_VER% - -rem This builds the docs in %WXWIN% in a number of formats -rem and a clean inno setup in a second tree -rem it uses a number of tools, gnuwin32 zip & dos2unix, -rem writes a log file in c:\ - -echo Building wxWidgets-%WXW_VER% docs... > c:\temp.log - -set WXWIN=c:\wx\wxWidgets -set DAILY=c:\daily -set INNO=c:\wx\inno\wxWidgets - -rem svn already in my path... -set PATH=%PATH%;c:\wx\Gnu\bin;c:\progra~1\htmlhe~1;C:\PROGRA~1\INNOSE~1;c:\wx\doxygen\bin -set PATH=%PATH%;C:\wx\Graphviz\bin -echo %PATH% >> c:\temp.log - - -rem update wxwidgets (holds docs) and inno (wxMSW setup.exe only) -c: -cd %WXWIN% -svn cleanup >> c:\temp.log -svn up >> c:\temp.log - -rem now inno -cd %INNO% >> c:\temp.log -rem Don't update the svn automatically -rem svn cleanup >> c:\temp.log -rem svn up >> c:\temp.log - -if exist include\wx\msw\setup.h del include\wx\msw\setup.h -if exist include\wx\univ\setup.h del include\wx\univ\setup.h - -del c*.* -svn up configure -svn up configure.in -svn up config.guess -svn up config.sub -dos2unix configure -dos2unix config.guess -dos2unix config.sub -copy include\wx\msw\setup0.h include\wx\msw\setup.h -copy include\wx\univ\setup0.h include\wx\univ\setup.h -echo SVN update >> c:\temp.log - -rem make chm -rem Now create standalone copies of docs (chm and htb) -cd %WXWIN%\docs\doxygen -del out\html\*.html -del out\html\*.htb -del out\html\*.zip -del out\*.chm -call regen chm - - -cd %WXWIN%\docs\doxygen\out -zip wxWidgets-%WXW_VER%-docs-chm.zip wx.chm -copy wxWidgets-%WXW_VER%-docs-chm.zip %DAILY% -cd html -del *.dot -del *.md5 -zip -r wx.htb *.* -copy wx.htb %DAILY%\wxWidgets-%WXW_VER%-docs-html.zip -zip wxWidgets-%WXW_VER%-docs-htb.zip wx.htb -copy wxWidgets-%WXW_VER%-docs-htb.zip %DAILY% - - -mkdir %INNO%\docs\htmlhelp -copy %WXWIN%\docs\doxygen\out\wx.chm %INNO%\docs\htmlhelp\wx.chm -cd %WXWIN%\build\tools -iscc wxwidgets.iss >> c:\temp.log -copy %INNO%\..\wxMSW-%WXW_VER%-Setup.exe c:\daily - -echo docs built for %WXW_VER% -echo docs built for %WXW_VER% >> c:\temp.log - - diff --git a/build/tools/make-html-docs.sh b/build/tools/make-html-docs.sh deleted file mode 100755 index 771b67e88f..0000000000 --- a/build/tools/make-html-docs.sh +++ /dev/null @@ -1,30 +0,0 @@ -#!/bin/sh -# -# This script creates archives of HTML documentation in tar.bz2 and zip -# formats. It relies on docs/doxygen/regen.sh to really generate the docs. -# -# The script should be ran from the root of wxWidgets checkout and creates the -# output files in its parent directory. - -version=$1 -if [ -z "$version" ]; then - echo "Must specify the distribution version." >&2 - exit 1 -fi - -set -e -set -x - -docs_dir_name=wxWidgets-$version -docs_file_basename=wxWidgets-$version-docs-html - -cd docs/doxygen -./regen.sh html -cd out -mv html $docs_dir_name -tar cjf ../../../../$docs_file_basename.tar.bz2 $docs_dir_name -cd $docs_dir_name -zip -q -r ../../../../../$docs_file_basename.zip . - -cd .. -mv $docs_dir_name html diff --git a/build/tools/release.bat b/build/tools/release.bat new file mode 100644 index 0000000000..4c4eacb3d5 --- /dev/null +++ b/build/tools/release.bat @@ -0,0 +1,71 @@ +@echo off +setlocal enabledelayedexpansion + +rem This script builds the CHM manual and the Windows installer for release. + +if "%1" == "" ( + echo You must specify a release version. + exit /b 1 +) + +pushd "%~dp0..\.." + +set root=%cd% +set version=%1 +set prefix=wxWidgets-%1 +set release_path=%root%\distrib\release\%version% + +where /q 7z +if %ERRORLEVEL% neq 0 ( + echo Error: 7-Zip was not found in your PATH. + exit /b 1 +) +where /q dot +if %ERRORLEVEL% neq 0 ( + echo Error: GraphViz was not found in your PATH. + exit /b 1 +) +where /q doxygen +if %ERRORLEVEL% neq 0 ( + echo Error: Doxygen was not found in your PATH. + exit /b 1 +) +where /q hhc +if %ERRORLEVEL% neq 0 ( + echo Error: HTML Help Workshop was not found in your PATH. + exit /b 1 +) +where /q iscc +if %ERRORLEVEL% neq 0 ( + echo Error: Inno Setup was not found in your PATH. + exit /b 1 +) + +if not exist "%release_path%\%prefix%.zip" ( + echo Error: Release ZIP package not found: %release_path%\%prefix%.zip + exit /b 1 +) + +pushd "%root%\docs\doxygen" +echo Building the CHM manual... +call regen.bat chm +if %errorlevel% neq 0 exit /b %errorlevel% +copy out\wx.chm "%release_path%\%prefix%.chm" +popd + +if exist "%release_path%\%prefix%" rd /s /q "%release_path%\%prefix%" +md "%release_path%\%prefix%" +pushd "%release_path%\%prefix%" +echo Extracting release ZIP for installer... +7z x "..\%prefix%.zip" +if %errorlevel% neq 0 exit /b %errorlevel% +md docs\htmlhelp +copy "..\%prefix%.chm" docs\htmlhelp\wx.chm +set WXW_VER=%1 +echo Building the installer... +iscc /Qp build\tools\wxwidgets.iss +if %errorlevel% neq 0 exit /b %errorlevel% +popd + +echo Cleaning up installer files... +rd /s /q "%release_path%\%prefix%" diff --git a/build/tools/git-make-release.sh b/build/tools/release.sh similarity index 63% rename from build/tools/git-make-release.sh rename to build/tools/release.sh index 50f48e164b..68dab59daa 100755 --- a/build/tools/git-make-release.sh +++ b/build/tools/release.sh @@ -6,11 +6,7 @@ # distribution and we don't need to maintain the list of them ourselves but we # also don't run the risk of including anything unwanted. # -# To summarize, here are the steps to create the release: -# -# % git tag vX.Y.Z -m 'Tag X.Y.Z release.' -# % ./build/tools/git-make-release.sh X.Y.Z -# % ... upload ../wxWidgets-X.Y.Z.{7z,tar.bz2,zip} ... +# See docs/contributing/how-to-release.md for usage instructions. version=$1 if [ -z "$version" ]; then @@ -18,6 +14,9 @@ if [ -z "$version" ]; then exit 1 fi +root="$(readlink -f $(dirname $(readlink -f $0))/../..)" +cd "$root" + if ! git diff --quiet; then echo "Working copy has modifications, commit or stash them." >&2 exit 2 @@ -27,18 +26,19 @@ set -e set -x prefix=wxWidgets-$version -destdir=$(dirname $(readlink -f $0))/../../../$prefix +destdir="$root/distrib/release/$version" cleanup() { - rm -rf $destdir + rm -rf $destdir/$prefix } trap cleanup INT TERM EXIT cleanup -git archive --prefix=$prefix/ HEAD | (cd ..; tar x) -cd .. +mkdir -p $destdir +git archive --prefix=$prefix/ HEAD | (cd $destdir; tar x) +cd $destdir # All setup0.h files are supposed to be renamed to just setup.h when checked # out and in the distribution. find $prefix/include/wx -type f -name setup0.h | while read f; do @@ -56,3 +56,16 @@ zip -q -r ../$prefix.zip . 7z a ../$prefix.7z . >/dev/null 7z a ../${prefix}-headers.7z include >/dev/null + +# Build HTML documentation packages. +prefix_docs=$prefix-docs-html +cd "$root/docs/doxygen" +rm -rf out +./regen.sh html +cd out +mv html "$prefix_docs" +tar cjf "$destdir/$prefix_docs.tar.bz2" "$prefix_docs" +cd "$prefix_docs" +zip -q -r "$destdir/$prefix_docs.zip" . +cd "$root" +rm -rf "$root/docs/doxygen/out" diff --git a/build/tools/wxwidgets.iss b/build/tools/wxwidgets.iss index 9819856bfa..bab33bc4c3 100644 --- a/build/tools/wxwidgets.iss +++ b/build/tools/wxwidgets.iss @@ -7,9 +7,9 @@ #define WXW_DIR "..\.." #endif -#if GetEnv("WXW_VER") == "git" - #define INFOFILE WXW_DIR + "\BuildGit.txt" - #define WX_VERSION "SVN" +#if GetEnv("WXW_VER") == "Snapshot" + #define INFOFILE WXW_DIR + "\BuildGit.txt" + #define WX_VERSION "Snapshot" #elif GetEnv("WXW_VER") != "" #define INFOFILE WXW_DIR + "\docs\msw\install.txt" #define WX_VERSION GetEnv("WXW_VER") diff --git a/docs/contributing/how-to-release.md b/docs/contributing/how-to-release.md index fa787f45fb..5cafbac5c9 100644 --- a/docs/contributing/how-to-release.md +++ b/docs/contributing/how-to-release.md @@ -2,14 +2,19 @@ Creating a new release requires a few things before getting started: -* Linux or OSX with 7z installed. -* Windows with HTML Help Workshop installed. -* Doxygen 1.8.8, and GraphViz installed on both machines. +* Linux or OSX. +* Windows 7+ with HTML Help Workshop, and Inno Setup installed. +* 7-Zip, Doxygen 1.8.8, and GraphViz installed on both machines. Unless mentioned otherwise, all steps should be run on Linux or OSX so that the repository export used for the release is primarily using LF line endings. Files that require CRLF line endings will be converted appropriately. +*Important:* Ensure that 7-Zip, HTML Help Workshop, Doxygen, GraphViz and Inno +Setup have all been added to your Path in Windows. You can confirm this by +running `7z`, `hhc`, `iscc`, `doxygen -v`, and `dot -V` in a command prompt. +Add the missing installed folder locations of any executables to your Path. + ## Pre-Release Steps * Change the version in `include/wx/version.h`. @@ -25,37 +30,27 @@ Finally, tag the release: ## Creating Release Files -Follow these steps assuming the current working directory is the root of git -working copy and you want to prepare distribution for the version x.y.z: +The release scripts can be run from any working directory, and they will +generate all release package files under `release/wxWidgets-x.y-z`. They all +build the release packages based on the current HEAD commit, so always ensure +you have the appropriate tag or commit checked out. -1. Run `./build/tools/git-make-release.sh x.y.z` to create source archives - `wxWidgets-x.y.z.{7z,tar.bz2,zip}` and `wxWidgets-x.y.z-headers.7z`. +1. Run `./build/tools/release.sh x.y.z` to create source archives + `wxWidgets-x.y.z.{7z,tar.bz2,zip}`, `wxWidgets-x.y.z-headers.7z`, and + `wxWidgets-x.y.z-docs-html.{tar.bz2,zip}` packages. -2. Run `./build/tools/make-html-docs.sh x.y.z` to create HTML documentation - archives `wxWidgets-x.y.z-docs-html.{tar.bz2,zip}`. +2. Copy just the `wxWidgets-x.y.z.zip` package into the same + `release\wxWidgets-x.y.z` folder on Windows. -3. Run the following commands under Windows since it relies on having `hhc.exe` - (the HTML Help compiler) in your PATH: +3. Run `build/tools/release.bat x.y.z` in a Windows command prompt. - ``` - cd docs\doxygen - regen.bat chm - cd out - zip ..\..\..\wxWidgets-x.y.z-docs-chm.zip wx.chm - ``` +4. Copy these Windows packages back to your Linux or OSX `release` directory so + you can continue with the upload step with all packages available: -4. This step also must be done under Windows as it uses Inno Setup to produce - the `.exe` file and it also requires the CHM file built above: - - ``` - md x.y.z-sources - cd x.y.z-sources - 7z x ..\wxWidgets-x.y.z.7z - md docs\htmlhelp - cp ..\docs\doxygen\out\wx.chm docs\htmlhelp - set WXW_VER=x.y.z - iscc build\tools\wxwidgets.iss - ``` + ``` + wxMSW-x.y.z-Setup.exe + wxWidgets-x.y.z.chm + ``` ## Uploading @@ -67,7 +62,7 @@ The following files need to be uploaded: wxWidgets-x.y.z.7z wxWidgets-x.y.z.tar.bz2 wxWidgets-x.y.z.zip - wxWidgets-x.y.z-docs-chm.zip + wxWidgets-x.y.z.chm wxWidgets-x.y.z-docs-html.tar.bz2 wxWidgets-x.y.z-docs-html.zip wxWidgets-x.y.z-headers.7z diff --git a/docs/doxygen/regen.bat b/docs/doxygen/regen.bat index 72a524df03..916502608c 100644 --- a/docs/doxygen/regen.bat +++ b/docs/doxygen/regen.bat @@ -4,9 +4,15 @@ REM This bash script regenerates the HTML doxygen version of the REM wxWidgets manual and adjusts the doxygen log to make it more REM readable. -mkdir out 2>&1 >NUL -mkdir out\html 2>&1 >NUL -mkdir out\html\generic 2>&1 >NUL +where /q doxygen +if %ERRORLEVEL% neq 0 ( + echo Error: Doxygen was not found in your PATH. + exit /b 1 +) + +if not exist out (mkdir out) +if not exist out\html (mkdir out\html) +if not exist out\html\generic (mkdir out\html\generic) REM These not automatically copied by Doxygen because they're not REM used in doxygen documentation, only in our html footer and by our @@ -92,6 +98,7 @@ REM not included! REM set PATH=%PATH%;%HHC_PATH% doxygen Doxyfile +if %errorlevel% neq 0 exit /b %errorlevel% REM Check that class inheritance diagram images are present for html/chm docs. REM diff --git a/docs/readme.txt b/docs/readme.txt index 6d1db20ad4..8da7d07733 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -1,172 +1,149 @@ - wxWidgets 3.1.0 Release Notes - ============================= +wxWidgets 3.1.0 Release Notes +============================= -Welcome to the latest development release of wxWidgets, a free and -open source cross-platform C++ framework for writing advanced GUI -applications using native controls. +Welcome to the latest development release of wxWidgets, a free and open source +cross-platform C++ framework for writing advanced GUI applications using native +controls. -wxWidgets allows you to write native-looking GUI applications for -all the major desktop platforms and also helps with abstracting -the differences in the non-GUI aspects between them. It is free -for the use in both open source and commercial applications, comes -with the full, easy to read and modify, source and extensive -documentation and a collection of more than a hundred examples. -You can learn more about wxWidgets at +wxWidgets allows you to write native-looking GUI applications for all the major +desktop platforms and also helps with abstracting the differences in the non-GUI +aspects between them. It is free for the use in both open source and commercial +applications, comes with the full, easy to read and modify, source and extensive +documentation and a collection of more than a hundred examples. You can learn +more about wxWidgets at: - https://www.wxwidgets.org/ +* https://www.wxwidgets.org/ -and read its documentation online at +Documentation is available online at: - http://docs.wxwidgets.org/3.1.0/ +* http://docs.wxwidgets.org/3.1.0/ -wxWidgets sources and binaries for the selected platforms are -available for download from +wxWidgets sources and binaries for the selected platforms are available for +download from: - https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.0/ - -Please see the "Files" section below for the description of various -files available at these locations. +* https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.0/ -Changes in this release ------------------------ +Changes +------- -Platforms supported + +Platforms Supported ------------------- wxWidgets currently supports the following primary platforms: -- Windows XP, Vista, 7, 8 and 10 (32/64 bits). -- Most Unix variants using the GTK+ toolkit (version 2.6 or newer) -- Mac OS X (10.7 or newer) using Cocoa (32/64 bits) or Carbon (32 only) +* Windows XP, Vista, 7, 8 and 10 (32/64 bits). +* Most Unix variants using the GTK+ toolkit (version 2.6 or newer) +* Mac OS X (10.7 or newer) using Cocoa (32/64 bits) or Carbon (32 only) There is some support for the following platforms: -- Most Unix variants with X11 -- Most Unix variants with Motif/Lesstif -- Most Unix variants with GTK+ 1.2 -- Most Unix variants with Qt 5 or newer +* Most Unix variants with X11 +* Most Unix variants with Motif/Lesstif +* Most Unix variants with GTK+ 1.2 +* Most Unix variants with Qt 5 or newer -Most popular C++ compilers are supported; see the install.txt -file for each platform (available via docs/html/index.htm) and -http://wiki.wxwidgets.org/Supported_Platforms for the most up to -date status. +Most popular C++ compilers are supported; see the install.txt file for each +platform (available via docs/html/index.htm) and +https://wiki.wxwidgets.org/Supported_Platforms for the most up to date status. Files ----- -wxWidgets is distributed in source form in several archive formats. -ZIP and 7z archives are for Microsoft Windows users and contain the -files with DOS/Windows line endings while the compressed tar archives -for Unix systems users (including OS X) and contain the files with -Unix line endings. Please notice that some Windows tools still don't -accept files with Unix line endings and that compiling sources with -DOS line endings under Unix will fail, so please choose the correct +wxWidgets is distributed in source form in several archive formats. ZIP and 7z +archives are for Microsoft Windows users and contain the files with DOS/Windows +line endings while the compressed tar archives for Unix systems users (including +OS X) and contain the files with Unix line endings. Please notice that some +Windows tools still don't accept files with Unix line endings and that compiling +sources with DOS line endings under Unix will fail, so please choose the correct file for your system. -In addition to the sources, documentation in HTML, CHM and HTB -(wxWidgets help viewer) formats is provided as well as an installer -for Microsoft Windows. Notice that you will still need to compile -wxWidgets even when using the installer. +In addition to the sources, documentation in HTML, CHM and HTB (wxWidgets help +viewer) formats is provided as well as an installer for Microsoft Windows. +Notice that you will still need to compile wxWidgets even when using the +installer. -We also supply binaries of wxMSW libraries built with several -versions of Microsoft Visual C++ and GNU g++ compiler for this -release. They are available in the "binaries" subdirectory, see -the description of the files in the README file there. +We also supply binaries of wxMSW libraries built with several versions of +Microsoft Visual C++ and GNU g++ compiler for this release. Installation ------------ -Unless you have downloaded the binaries for your compiler, you -will need to build wxWidgets before you can test out the samples -or write your own applications. For installation information, -please see the install.txt file in the docs subdirectory -appropriate for the platform you use. +Unless you have downloaded the binaries for your compiler, you will need to +build wxWidgets before you can test out the samples or write your own +applications. For installation information, please see the install.txt file in +the docs subdirectory appropriate for the platform you use. -Licence information -------------------- +Licence +------- For licensing information, please see the files: - docs/preamble.txt - docs/licence.txt - docs/licendoc.txt - docs/gpl.txt - docs/lgpl.txt - docs/xserver.txt +* docs/preamble.txt +* docs/licence.txt +* docs/licendoc.txt +* docs/gpl.txt +* docs/lgpl.txt +* docs/xserver.txt -Although this may seem complex, it is there to allow authors of -proprietary/commercial applications to use wxWidgets in addition -to those writing GPL'ed applications. In summary, the licence is -LGPL plus a clause allowing unrestricted distribution of -application binaries. To answer a FAQ, you don't have to -distribute any source if you wish to write commercial -applications using wxWidgets. +Although this may seem complex, it is there to allow authors of proprietary, +commercial applications to use wxWidgets in addition to those writing GPL'ed +applications. In summary, the licence is LGPL plus a clause allowing +unrestricted distribution of application binaries. To answer a FAQ, you don't +have to distribute any source if you wish to write commercial applications using +wxWidgets. -However, if you distribute wxGTK, wxQt or wxMotif (with Lesstif) -version of your application, don't forget that it is linked -against GTK+, Qt or Lesstif, which are covered by LGPL *without* -exception notice and so is bound by its requirements. +However, if you distribute wxGTK, wxQt or wxMotif (with Lesstif) version of your +application, don't forget that it is linked against GTK+, Qt or Lesstif, which +are covered by LGPL *without* exception notice and so is bound by its +requirements. -If you use TIFF image handler, please see src/tiff/COPYRIGHT -for libtiff licence details. - -If you use JPEG image handler, documentation for your program -should contain following sentence: "This software is based in -part on the work of the Independent JPEG Group". See -src/jpeg/README for details. - -If you use wxRegEx class on a system without native regular -expressions support (i.e. MS Windows), see src/regex/COPYRIGHT -file for Henry Spencer's regular expression library copyright. - -If you use wxXML classes or XRC, see src/expat/COPYING for licence +If you use TIFF image handler, please see src/tiff/COPYRIGHT for libtiff licence details. +If you use JPEG image handler, documentation for your program should contain +following sentence: "This software is based in part on the work of the +Independent JPEG Group". See src/jpeg/README for details. -Documentation -------------- +If you use wxRegEx class on a system without native regular expressions support +(i.e. MS Windows), see src/regex/COPYRIGHT file for Henry Spencer's regular +expression library copyright. -wxWidgets documentation is available online at -http://docs.wxwidgets.org/3.1.0/ and can also be downloaded in -HTML format. To generate documentation in other formats (PDF, CHM, -...) please use the scripts in docs/doxygen directory. +If you use wxXML classes or XRC, see src/expat/COPYING for licence details. -Bug reporting -------------- +Reporting Bugs +-------------- -The wxWidgets bug tracker can be browsed at: +The wxWidgets bug tracker can be found here: - http://trac.wxwidgets.org/newticket +* http://trac.wxwidgets.org/newticket -Please use the search function of our Trac installation to find -any possibly relevant bugs before reporting new ones. Also please -notice that often trying to correct the bug yourself is the -quickest way to fix it. Even if you fail to do it, you may -discover valuable information allowing us to fix it while doing -it. We also give much higher priority to bug reports with patches -fixing the problems so this ensures that your report will be -addressed sooner. +Please use the search function of our Trac installation to find any possibly +relevant bugs before reporting new ones. Also please notice that often trying to +correct the bug yourself is the quickest way to fix it. Even if you fail to do +it, you may discover valuable information allowing us to fix it while doing it. +We also give much higher priority to bug reports with patches fixing the +problems so this ensures that your report will be addressed sooner. -Further information +Further Information ------------------- If you are looking for support, you can get it from -- Mailing Lists: https://www.wxwidgets.org/support/mailing-lists/ -- Discussion Forums: https://forums.wxwidgets.org/ -- #wxwidgets IRC Channel: https://www.wxwidgets.org/support/irc/ -- Stack Overflow (tag your questions with "wxwidgets"): +* Mailing Lists: https://www.wxwidgets.org/support/mailing-lists/ +* Discussion Forums: https://forums.wxwidgets.org/ +* #wxwidgets IRC Channel: https://www.wxwidgets.org/support/irc/ +* Stack Overflow (tag your questions with "wxwidgets"): https://stackoverflow.com/questions/tagged/wxwidgets -- Please report bugs at http://trac.wxwidgets.org/newticket Have fun! -The wxWidgets Team, August 2014 +The wxWidgets Team, October 2015 diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 0000000000..5746caff1b --- /dev/null +++ b/docs/release.md @@ -0,0 +1,117 @@ +Welcome to wxWidgets, a free and open source cross-platform C++ framework for +writing advanced GUI applications using native controls. + +Please notice that since the 2.9 series, only a single source distribution is +provided instead of the multiple distributions containing only the files for +each port as was done before. So you only need to download wxWidgets-3.0.0.zip +(or .7z for much smaller archive size) for Microsoft Windows systems or +wxWidgets-3.0.0.tar.bz2 for Unix ones, including Mac OS X. The only difference +between these files is that the ZIP (and 7z) archives contain files with DOS +line endings while the tar balls contain files with Unix line endings. + +## Reporting Problems + +Please report any bugs to the [issue tracker](http://trac.wxwidgets.org/report) +or the [wx-users mailing list](http://groups.google.com/group/wx-users). + +## Download Verification + +To verify your download please use the following sha1sums: + +``` +ceac35caeab6a0d3bdc6715b23dde82812ed8f7f wxMSW-3.0.2-Setup.exe +8cc75cc76aca18cdfbf66283015af620b5457014 wxWidgets-3.0.2.7z +6461eab4428c0a8b9e41781b8787510484dea800 wxWidgets-3.0.2.tar.bz2 +e9e5aeb0cabd998db737ffb0af165e7a8e02d68f wxWidgets-3.0.2.zip +9db3068925a7c928062e3db59ab1aca5b0e654a9 wxWidgets-3.0.2-docs-html.tar.bz2 +a58c1625679d78ec20cea4542dc1382b6a7a01e8 wxWidgets-3.0.2-docs-html.zip +591e706da0d2358ff392adaff706c9df2bd42a10 wxWidgets-3.0.2-docs-chm.zip +7670804d478a5b7008f5d7a82c30f0c6bfd358bf wxWidgets-3.0.2_headers.7z +``` + +## Binaries + +We have provided pre-built binary files for the following compilers: + +* Microsoft Visual C++ compiler versions 9.0, 10.0, 11.0 and 12.0 corresponding + to marketing product names of Microsoft Visual Studio 2008, 2010, 2012 and + 2013 respectively. +* MinGW-TDM versions 4.7.1 and 4.8.1 (with the default SJLJ exceptions + propagation method). + +### For Developers + +For developing applications with wxWidgets you need to download the +compiler-independent `wxWidgets-3.0.2_Headers.7z` file and one of +`wxMSW-3.0.2-vcXXX_Dev.7z` or `wxMSW-3.0.2_gccXXX_Dev.7z` files depending on +your compiler, its version and the target architecture (x86 if not specified or +x64). + +Unpack both files into the same directory so that `include` and `lib` +directories are at the same level after unpacking. You should be able to compile +and link applications using wxWidgets in both debug and release modes but the +debug symbols are provided only for debug libraries in this archive, see below +for the release build debug symbols. + +### For End Users + +End users may download one of `wxMSW-3.0.2_vcXXX_ReleaseDLL.7z` or +`wxMSW-3.0.2_gccXXX_ReleaseDLL.7z` files to get just the DLLs required for +running the applications using wxWidgets. + +### For Debugging + +* Microsoft Visual C++ users: Files `wxMSW-3.0.2_vcXXX_ReleasePDB.7z` contain + the debug symbols for the release build of the DLLs. Download them if you want + to debug your own applications in release build or if you want to get + meaningful information from mini-dumps retrieved from your users machines. +* MinGW-TDM users: Currently the debug symbols are not available for the release + build of the DLLs (only the debug versions of the DLLs contains the debug + symbols). + +### Binary File Download Verification + +To verify your download please use the following sha1sums: + +``` +d4de907d5cbbc6feabec3ae06b7cb875f2f552f6 wxMSW-3.0.2_gcc471TDM_Dev.7z +55ff0cd21df57ad6d25895964c13e421f86c0781 wxMSW-3.0.2_gcc471TDM_ReleaseDLL.7z +5856429ba46f29689e95a86b97a741ed42ebad98 wxMSW-3.0.2_gcc471TDM_x64_Dev.7z +6c4289652aa06b1ff2e28e72250c3ecd61b36acd wxMSW-3.0.2_gcc471TDM_x64_ReleaseDLL.7z +e9e09cfe9c64c528a4e5b825f1d4eb93d41da490 wxMSW-3.0.2_gcc481TDM_Dev.7z +1f5e03d3e07812270fdd15f7ea47ccd43cb41f01 wxMSW-3.0.2_gcc481TDM_ReleaseDLL.7z +ff2a74d4298f58f7a1f9412ee632c8c695ca7efe wxMSW-3.0.2_gcc481TDM_x64_Dev.7z +713860af5d001e3affdfae4003c3479fcceae72d wxMSW-3.0.2_gcc481TDM_x64_ReleaseDLL.7z +c675da612bc702c66cc985ac02262a0529df34b0 wxMSW-3.0.2_vc90_Dev.7z +2ee0d4c15bf4453ad5f3c3656a5a76bb489ed267 wxMSW-3.0.2_vc90_ReleaseDLL.7z +1006789fdff272058803c28ec77aff328dab2de2 wxMSW-3.0.2_vc90_ReleasePDB.7z +1c815bafd9e8506549800354e44b22af60631941 wxMSW-3.0.2_vc90_x64_Dev.7z +2830484c43193e72f994adc3601438fde354fb4c wxMSW-3.0.2_vc90_x64_ReleaseDLL.7z +9a1e87141345c818f58e523766c5e42ab9ecfb02 wxMSW-3.0.2_vc90_x64_ReleaseDLL.msi +1c9094ab4fa93875477ceb99d72db2a904c48136 wxMSW-3.0.2_vc90_x64_ReleasePDB.7z +5d1c2ad76c85bba32cc6329446bc70632af245ae wxMSW-3.0.2_vc90_x86_ReleaseDLL.msi +d51026d681916f86cd34885cccc4408e8b0b3962 wxMSW-3.0.2_vc100_Dev.7z +f1fd09ab3ced110afd0ecaa191117533981928ed wxMSW-3.0.2_vc100_ReleaseDLL.7z +da515bdf35a2aa8972614865ab4687da4727fae7 wxMSW-3.0.2_vc100_ReleasePDB.7z +deec659658076e46e794d73b2b4f4cf812a27278 wxMSW-3.0.2_vc100_x64_Dev.7z +7c9c0a710112f993655a0b51a9dc63206897d553 wxMSW-3.0.2_vc100_x64_ReleaseDLL.7z +ea22edf6983a282513571ee2901ed18035aadf80 wxMSW-3.0.2_vc100_x64_ReleaseDLL.msi +1f2eeecdf2355f89c70fa94c364afd3267b1f51f wxMSW-3.0.2_vc100_x64_ReleasePDB.7z +00b47fc629868d3634e13eefc4adc08d6e822853 wxMSW-3.0.2_vc100_x86_ReleaseDLL.msi +33e9e9216b1c0fafc44fd681520a746465eb30d6 wxMSW-3.0.2_vc110_Dev.7z +e38f4f7c00ba58bf90afa53474ca0fdafa8ea791 wxMSW-3.0.2_vc110_ReleaseDLL.7z +d5ce2cf60829b4fda83439975ff4f7d857dda92d wxMSW-3.0.2_vc110_ReleasePDB.7z +46e5a66a65db34107a089d1aef326c25cafbe7af wxMSW-3.0.2_vc110_x64_Dev.7z +fff956c21826e5268b1533fc0b4fad6016963be0 wxMSW-3.0.2_vc110_x64_ReleaseDLL.7z +2c3b6f6e63a40027bca9601d7668999dec596013 wxMSW-3.0.2_vc110_x64_ReleaseDLL.msi +8a0c6e9bd844e204e26955573049fb17ce704d60 wxMSW-3.0.2_vc110_x64_ReleasePDB.7z +98ac8e4163d972610267fa8e070adb9b5b4e1f13 wxMSW-3.0.2_vc110_x86_ReleaseDLL.msi +87bee27e5b15852cb81862bb5245c751a70ee9ac wxMSW-3.0.2_vc120_Dev.7z +f1cc74b0a558af80ceac350a5777a4a54d226315 wxMSW-3.0.2_vc120_ReleaseDLL.7z +cb4e92c6bbd4a25b7d92f8490dd85482e1d32c7d wxMSW-3.0.2_vc120_ReleasePDB.7z +f7c8dad92deed936faecc8b59e13a6ac1c4fd4e4 wxMSW-3.0.2_vc120_x64_Dev.7z +77f2ac56edf5739ed7af261698069776cfef86d5 wxMSW-3.0.2_vc120_x64_ReleaseDLL.7z +4a33022c59f484d4da6979581e0ba409c804764f wxMSW-3.0.2_vc120_x64_ReleaseDLL.msi +51e047f1576a61d5b5e019b6579b12ab4bdfb941 wxMSW-3.0.2_vc120_x64_ReleasePDB.7z +a31f3af0de6dd331dd0984ebaeef643f3f856aba wxMSW-3.0.2_vc120_x86_ReleaseDLL.msi +``` diff --git a/docs/release_binaries.mdwn b/docs/release_binaries.mdwn deleted file mode 100644 index 72dbd9a2c3..0000000000 --- a/docs/release_binaries.mdwn +++ /dev/null @@ -1,112 +0,0 @@ -wxWidgets 3.0.0 Binaries -======================== - -This directory contains binary files for wxWidgets 3.0.0 release. - -* Microsoft Visual C++ compiler versions 9.0, 10.0, 11.0 and 12.0 - corresponding to marketing product names of Microsoft Visual Studio - 2008, 2010, 2012 and 2013 respectively. -* MinGW-TDM versions 4.7.1 and 4.8.1 (with the default SJLJ exceptions - propagation method). - - -For Developers --------------- - -For developing applications with wxWidgets you need to download the -compiler-independent wxWidgets-3.0.0_Headers.7z file (found in the -parent directory) and one of wxMSW-3.0.0-vcXXX_Dev.7z or -wxMSW-3.0.0_gccXXX_Dev.7z files depending on your compiler, its -version and the target architecture (x86 if not specified or x64). - -Unpack both files into the same directory so that "include" and "lib" -directories are at the same level after unpacking. You should be able -to compile and link applications using wxWidgets in both debug and -release modes but the debug symbols are provided only for debug -libraries in this archive, see below for the release build debug -symbols. - - -For End Users -------------- - -End users may download one of wxMSW-3.0.0_vcXXX_ReleaseDLL.7z or -wxMSW-3.0.0_gccXXX_ReleaseDLL.7z files to get just the DLLs -required for running the applications using wxWidgets. - - -For Debugging -------------- - -* Microsoft Visual C++ users: Files wxMSW-3.0.0_vcXXX_ReleasePDB.7z - contain the debug symbols for the release build of the DLLs. Download - them if you want to debug your own applications in release build or - if you want to get meaningful information from mini-dumps retrieved - from your users machines. -* MinGW-TDM users: Currently the debug symbols are not available for - the release build of the DLLs (only the debug versions of the DLLs - contains the debug symbols). - - -Feedback --------- - -This is our first attempt to provide binaries for a major wxWidgets -release and we are very interested in your feedback. Please let us -know if these files are useful to you and how could they be made more -so and, of course, if you run into any problems with them. Looking -forward to hearing from you on [wx-users mailing list](http://groups.google.com/group/wx-users). - - -Check Sums ----------- - -To verify your download you can use the following sha1sums: - - 4c6bf24df85bc0fb1bce3091557963ec4c79b5f4 wxMSW-3.0.0_gcc471TDM_Dev.7z - c35de8230a0e006883b58078b1bcb597a923b110 wxMSW-3.0.0_gcc471TDM_ReleaseDLL.7z - 5844ad74ef07f468f36a4b232e28bb5c6753eb91 wxMSW-3.0.0_gcc471TDM_x64_Dev.7z - df3129074172278d1837d7c7698e5466dcdd87af wxMSW-3.0.0_gcc471TDM_x64_ReleaseDLL.7z - 34268fdd29b3d3b904234796cae847c9648119f7 wxMSW-3.0.0_gcc481TDM_Dev.7z - 15871a10eb3d2c005e34ea20ea921400d51b7392 wxMSW-3.0.0_gcc481TDM_ReleaseDLL.7z - 3f89fd4e8f78f26c18cfee4781a2a6c1e3ae2655 wxMSW-3.0.0_gcc481TDM_x64_Dev.7z - 013c2f7ab65182f8c6c9d805a16d23827ed24c9e wxMSW-3.0.0_gcc481TDM_x64_ReleaseDLL.7z - 1a3ba38a309182a32f24225f392b3a35a31f9ea1 wxMSW-3.0.0_vc90_Dev.7z - 97ace7370b85813cb04196fbe71bc1caeb08bb79 wxMSW-3.0.0_vc90_ReleaseDLL.7z - ad98029154d9a0ef2d7d62756f796c82715a2c02 wxMSW-3.0.0_vc90_x86_ReleaseDLL.msi - 83c727c2337eaee4dc93e90d33a85b0dafe9b745 wxMSW-3.0.0_vc90_ReleasePDB.7z - b14eb5cab613cc583ada83ed38113dee9b8b08bb wxMSW-3.0.0_vc90_x64_Dev.7z - 1cf0d5918e961e31b67d70530e00be6cac06af57 wxMSW-3.0.0_vc90_x64_ReleaseDLL.7z - 6ab1d777b784c7e02a331577f6d676f51261af25 wxMSW-3.0.0_vc90_x64_ReleaseDLL.msi - 839e5033e760508a3d50314056821a7e91a4a2e4 wxMSW-3.0.0_vc90_x64_ReleasePDB.7z - 397ee6d2de469647a3444df1def495bb16ba54b0 wxMSW-3.0.0_vc100_Dev.7z - 0e1b88b313ff438c1db840a60d146dee218deb6f wxMSW-3.0.0_vc100_ReleaseDLL.7z - 25cc1e30d09ae3823288e224572e2b5d89673b2a wxMSW-3.0.0_vc100_x86_ReleaseDLL.msi - 229136142f7d2980be72265ecc50eeea0096afca wxMSW-3.0.0_vc100_ReleasePDB.7z - 3e4e5a7a1eb800fe9d9be658c655ca49d6260791 wxMSW-3.0.0_vc100_x64_Dev.7z - eda263f3b1aae120e802aeab43ccc3ee45411a9e wxMSW-3.0.0_vc100_x64_ReleaseDLL.7z - 8991eb4d14f0b37a6aeed8f1f2ef71e2ee961fb0 wxMSW-3.0.0_vc100_x64_ReleaseDLL.msi - 86661c50965b3619f3d0f68a900ec8e1e0eaf9fb wxMSW-3.0.0_vc100_x64_ReleasePDB.7z - 2c25693325f8516a4e923fd520b540a4947b2757 wxMSW-3.0.0_vc110_Dev.7z - 1c81fd5cdb4c62c1494accc7f1c9ba9acabfa79c wxMSW-3.0.0_vc110_ReleaseDLL.7z - aab75c6db1d491d38544d4feaf721931ee7aabb3 wxMSW-3.0.0_vc110_x86_ReleaseDLL.msi - 4dbb2058b6c8c11e9d906f6520792103779c8518 wxMSW-3.0.0_vc110_ReleasePDB.7z - c64b64138450ce35c385f9f9d01ee44fb27a59b1 wxMSW-3.0.0_vc110_x64_Dev.7z - 5503382c0a1b2148fed5d856fc5ddfc01e59dada wxMSW-3.0.0_vc110_x64_ReleaseDLL.7z - 7da39e4370391e41e13d2be9f7d59b36a78a8a8c wxMSW-3.0.0_vc110_x64_ReleaseDLL.msi - cff85ab5a0a560cac5d1f196a8cf0a1c1025aab8 wxMSW-3.0.0_vc110_x64_ReleasePDB.7z - 448827167a64a9a7c270774d62d8673445acbe63 wxMSW-3.0.0_vc120_Dev.7z - 0df76ee66bea2b3c312c4a67d5b6383440a85d22 wxMSW-3.0.0_vc120_ReleaseDLL.7z - 7e3249a3b989340fc3e87b1ba0031563d326cd92 wxMSW-3.0.0_vc120_x86_ReleaseDLL.msi - d74c3913389b8c441480b1a9d4c79211a457c05b wxMSW-3.0.0_vc120_ReleasePDB.7z - 9f6b3290f5fd3b179ff148d1cfc2748ddc0839a9 wxMSW-3.0.0_vc120_x64_Dev.7z - d2d555d923f18b71d5f0538e88a8740573df12a6 wxMSW-3.0.0_vc120_x64_ReleaseDLL.7z - 9383ee555c45772865b01260da9d02a8658683da wxMSW-3.0.0_vc120_x64_ReleaseDLL.msi - d3f24aa95d80f4a04d2b211b99fae7ca368e77b6 wxMSW-3.0.0_vc120_x64_ReleasePDB.7z - - -Credit ------- - -Thanks to Danny Scott and Xavier Perrissoud for providing MSVC and -MinGW-TDM binaries, respectively! diff --git a/docs/release_files.mdwn b/docs/release_files.mdwn deleted file mode 100644 index b50ffe0b24..0000000000 --- a/docs/release_files.mdwn +++ /dev/null @@ -1,36 +0,0 @@ -wxWidgets 3.0.0 -=============== - -This directory contains the files containing the sources and documentation of -wxWidgets 3.0.0 release. Please see the binaries subdirectory for the binaries -for the selected platforms/compilers. - -Please notice that since the 2.9 series only a single source distribution is -provided instead of the multiple distributions containing only the files for -each port as was done before. So you only need to download wxWidgets-3.0.0.zip -(or .7z for much smaller archive size) for Microsoft Windows systems or -wxWidgets-3.0.0.tar.bz2 for Unix ones, including Mac OS X. The only difference -between these files is that the ZIP (and 7z) archives contain files with DOS -line endings while the tar balls contain files with Unix line endings. - - -Reporting Problems ------------------- - -Please report any bugs in this release using [our Trac](http://trac.wxwidgets.org/report) -or by posting to [wx-users mailing list](http://groups.google.com/group/wx-users). - - -Check Sums ----------- - -To verify your download you can use the following sha1sums: - - d19985b4ea4277ac7707615b7c00b15e3d58d2c0 wxWidgets-3.0.0.7z - 756a9c54d1f411e262f03bacb78ccef085a9880a wxWidgets-3.0.0.tar.bz2 - becf924bb06441bfd2e7f3f4bf4501e58ff5c7b8 wxWidgets-3.0.0.zip - 6950f26601f5b71f955803854b19dce22af5e020 wxWidgets-3.0.0-docs-html.tar.bz2 - b2909e17d19765cedf9d79793a78c3f7eda7d88b wxWidgets-3.0.0-docs-html.zip - bf0d8baa476baba8ac13442a6c9cd74c2f356993 wxWidgets-3.0.0-docs-chm.zip - 2f4f7013845930e069b4f3c5226d771eadee6986 wxWidgets-3.0.0_headers.7z - ff997beecf047ef9c94a1caccd9770300033c136 wxMSW-3.0.0-Setup.exe