Skip to content

Commit 8a40d23

Browse files
committed
Update release notes etc for 3.1.3 release
Also simplify MSVC binaries use instructions by instructing people to just use the provided properties file.
1 parent 57f3a20 commit 8a40d23

File tree

6 files changed

+137
-130
lines changed

6 files changed

+137
-130
lines changed

‎docs/contributing/how-to-release.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ and then run it using the new DLLs.
5050
the straightforward changes like updating the date and version number
5151
automatically, but please also review and update the contents of the README
5252
and announcement text.
53+
54+
Note that the best order depends on the release being prepared: for a
55+
development release, `docs/publicity/announce.txt` contains the list of the
56+
major changes since the last stable release and should be updated first, as
57+
this part of it can then be copied verbatim to the corresponding section of
58+
the README file. For the stable releases, it's probably more convenient to
59+
update the README with the details of the changes first.
60+
61+
Here is the list of the files, for reference:
5362
* Update `docs/readme.txt`: version needs to be changed, content updated.
5463
* Update `docs/release.md`: also version and reset SHA-1 sums to zeroes.
5564
* Put a date on the release line in `docs/changes.txt`.

‎docs/doxygen/mainpages/manual.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
@author Julian Smart, Vadim Zeitlin, Robin Dunn, Stefan Csomor,
1515
Bryan Petty, Francesco Montorsi, Robert Roebling et al
1616
17-
@date December 10, 2018
17+
@date October 28, 2019
1818
1919
Welcome to wxWidgets, a stable and powerful open source framework for
2020
developing native cross-platform GUI applications in C++!

‎docs/msw/binaries.md‎

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Supported Compilers
88
We provide pre-built binary files for the following compilers:
99

1010
* Microsoft Visual C++ compiler versions 9.0, 10.0, 11.0, 12.0, 14.0, 14.1 and 14.2
11-
(corresponding to marketing product names of Microsoft Visual Studio 2008, 2010, 2012, 2013, 2015, 2017 and 2019 respectively).
11+
(corresponding to marketing product names of Microsoft Visual Studio 2008, 2010, 2012, 2013, 2015, 2017 and 2019 respectively). Please note that MSVC 14.x versions are ABI-compatible and the same set of binaries is used for all of them.
1212
* TDM-GCC version 5.1 and MinGW-w64 version 7.2 (with the default SJLJ
1313
exceptions propagation method, using C++11). Please note that you need to use
1414
the very latest MinGW-w64 7.2 compiler release with this version of the
@@ -24,7 +24,7 @@ Getting the files
2424
-----------------
2525

2626
First, you need to get the correct files. You will always need the
27-
`wxWidgets-3.1.1-headers.7z` one but the rest depends on your compiler version
27+
`wxWidgets-3.1.3-headers.7z` one but the rest depends on your compiler version
2828
and architecture: as different versions of MSVC compiler are not binary
2929
compatible, you should select the files with the correct
3030
`vc80`, `vc90`, `vc100`, `vc110`, `vc120`, or `vc14x`
@@ -35,14 +35,14 @@ or the ones without this suffix for the still more common 32-bit builds. After
3535
determining the combination of suffixes you need, you should download the
3636
"Dev" and the "ReleaseDLL" files in addition to the "Headers" one above,
3737
e.g. for 32-bit MSVS 2017 development you need
38-
`wxMSW-3.1.1_vc14x_Dev.7z` and `wxMSW-3.1.1_vc14x_ReleaseDLL.7z`.
38+
`wxMSW-3.1.3_vc14x_Dev.7z` and `wxMSW-3.1.3_vc14x_ReleaseDLL.7z`.
3939

4040
All binaries are available at:
4141

42-
https://github.com/wxWidgets/wxWidgets/releases/v3.1.1
42+
https://github.com/wxWidgets/wxWidgets/releases/v3.1.3
4343

4444
Once you have the files you need, unzip all of them into the same directory, for
45-
example `c:\wx\3.1.1`. You should have only include and lib subdirectories under
45+
example `c:\wx\3.1.3`. You should have only include and lib subdirectories under
4646
it, nothing else. To avoid hard-coding this path into your projects, define
4747
`wxwin` environment variable containing it: although it's a little known fact,
4848
all versions of MSVC support environment variable expansion in the C++ projects
@@ -51,42 +51,16 @@ all versions of MSVC support environment variable expansion in the C++ projects
5151
Using Binaries with Visual Studio
5252
---------------------------------
5353

54-
Next step is to set up your project to use these files. You need to do the
55-
following:
54+
Next step is to set up your project to use these files: for this, simply add
55+
the provided `wxwidgets.props` file as a property sheet to your project.
56+
This can be done using `View|Property Manager` menu item in the IDE and
57+
selecting "Add Existing Property Sheet..." from the project popup menu.
5658

57-
* In the compiler options, i.e. "C/C++" properties:
58-
* Add `$``(wxwin)/include/msvc;$``(wxwin)/include` to the "Additional Include
59-
Directories". Notice that the order is important here, putting the
60-
MSVC-specific directory first ensures that you use `wx/setup.h`
61-
automatically linking in wxWidgets libraries.
62-
* Add `WXUSINGDLL` and `wxMSVC_VERSION_ABI_COMPAT` to the list of defined
63-
symbols in "Preprocessor Definitions". The first should be
64-
self-explanatory (we only provide DLLs, not static libraries) while the
65-
second one is necessary to use the libraries from e.g. `lib\vc100_dll`
66-
directory and not the default `lib\vc_dll`.
67-
* Also check that `_UNICODE` and `UNICODE` symbols are defined in the same
68-
"Preprocessor Definitions" section. This should already be the case for
69-
the newly created projects but it might be necessary to add them if
70-
you're upgrading an existing one.
71-
* Check that you use "Multi-threaded \[Debug\] DLL" in the "Run-time
72-
library" option under "Code Generation" to ensure that your build uses
73-
the same CRT version as our binaries.
74-
* In the linker options you only need to add `$``(wxwin)\lib\vc$``(PlatformToolsetVersion)_dll`
75-
(the standard `PlatformToolsetVersion` macro expands into something like
76-
`141`, depending on the toolset version being used, and you could also use
77-
the version number directly if you prefer) to "Additional Library
78-
Directories" under "Linker\\General" in the options. Thanks to the use of
79-
MSVC-specific `setup.h` you don't need to list wxWidgets libraries manually,
80-
i.e. you do **not** need to put anything in the list of "Additional
81-
Dependencies".
59+
Note: your project must use "Unicode Character Set" option.
8260

83-
Now you should be able to build your project successfully, both in "Debug" and
84-
"Release" configurations. With MSVS 10 or newer it can also be done from the
85-
command line using `msbuild.exe`. Of course, to run the generated executable
86-
you will need to either add the directory containing wxWidgets DLLs to your PATH
87-
or copy the DLL files to a directory already on it. Finally, if you want to
88-
distribute the binaries created using these options, you will need to install
89-
Microsoft Visual C++ run-time DLLs. Again, MSVC 10 or newer has an advantage
90-
here as you can simply copy `msvcp100.dll` and `msvcr100.dll` as any other DLL,
91-
while you need to install specially for the previous compiler versions that
92-
use WinSxS ("side-by-side") for them.
61+
Now you should be able to build and run your project successfully, both in
62+
"Debug" and "Release" configurations. Please note that during run-time the
63+
executables will require wxWidgets DLLs in addition to MSVC run-time DLLs, so
64+
you should consider adding the directory containing these DLLs to your PATH and
65+
either distributing them with your application or instructing your users to
66+
download them.

‎docs/publicity/announce.txt‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
December 10, 2018 -- The wxWidgets team is pleased to announce a new
1+
October 28, 2019 -- The wxWidgets team is pleased to announce a new
22
release of our open source framework for the development of native
33
cross-platform applications in C++.
44

5-
wxWidgets 3.1.2 is the latest release in the 3.1 development
5+
wxWidgets 3.1.3 is the latest release in the 3.1 development
66
branch and is now available at
77

8-
https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.2
8+
https://github.com/wxWidgets/wxWidgets/releases/tag/v3.1.3
99

1010
Compared to the stable 3.0.x series, this version brings many
1111
improvements and even more bug fixes, please see the change log
1212

13-
https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.2/docs/changes.txt
13+
https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.3/docs/changes.txt
1414

1515
for the incomplete list of the most important ones. Here is the
1616
maximally condensed summary of the changes compared to 3.0:
1717

18-
- Build system improvements: support for new compilers (MSVS 2017, g++ 8) and
19-
OS versions (macOS 10.14 and its dark mode) as well as an entirely new CMake
20-
build system.
21-
- New features: support for mouse gesture events (GSoC 2017 project);
22-
non-integer font sizes and arbitrary font weights in wxFont; fractional pen
23-
widths in wxGraphicsContext; arbitrary label windows in wxStaticBox; markup
24-
in wxDataViewCtrl items text; better support for high DPI monitors; support
25-
for ZIP 64 files; LZMA compression; much improved accessibility support under
26-
MSW.
18+
- Build system improvements: support for new compilers (up to MSVS 2019, g++ 9)
19+
with an even simpler way of using wxWidgets from MSVS, with wxwidgets.props
20+
file, and OS versions as well as an entirely new CMake build system.
21+
- Support for native dark mode under macOS 10.14 Mojave and later.
22+
- New features: implement freezing rows/columns in wxGrid; support for mouse
23+
gesture events (GSoC 2017 project); non-integer font sizes and arbitrary font
24+
weights in wxFont; fractional pen widths in wxGraphicsContext; arbitrary
25+
label windows in wxStaticBox; markup in wxDataViewCtrl items text; better
26+
support for high DPI monitors and per-monitor DPI and dynamic DPI changes
27+
support under MSW; support for ZIP 64 files; LZMA compression; much improved
28+
accessibility support under MSW.
2729
- New classes: wxActivityIndicator, wxAddRemoveCtrl,
2830
wxAppProgressIndicator, wxNativeWindow, wxPowerResourceBlocker,
2931
wxSecretStore.
@@ -33,6 +35,8 @@ maximally condensed summary of the changes compared to 3.0:
3335
wxListBox::GetTopItem(), wxProcess::Activate(), wxTextEntry::ForceUpper(),
3436
several ones in wxRendererNative, wxStandardPaths::GetUserDir(),
3537
wxToolbook::EnablePage(), wxUIActionSimulator::Select() and many others.
38+
- New XRC handlers for wxActivityIndicator, wxAui classes, wxDataViewCtrl,
39+
wxInfoBar, wxSimplebook, wxSpinCtrlDouble.
3640
- Significant improvements to: wxBusyInfo, wxDataViewCtrl,
3741
wxNotificationMessage, wxStaticBox, wxStyledTextCtrl.
3842
- Latest versions of all bundled 3rd party libraries, including all the

‎docs/readme.txt‎

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,28 @@ download from:
2727
Changes since 3.1.2
2828
-------------------
2929

30-
TODO: Fill in
30+
There have been almost 2000 commits from 97 unique contributors (52 with
31+
multiple contributions) since 3.1.2 releases, so it is impossible to summarize
32+
all the changes in this document without making it too long, please see the
33+
full changelog at
3134

32-
Notice that this release is almost completely compatible with 3.1.2 at the API
33-
level, so upgrading to it if you're already using wxWidgets 3 should be
34-
straightforward.
35+
https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.3/docs/changes.txt
36+
37+
for more details, but some of the most important changes are:
38+
39+
- Support for per-monitor DPI and dynamic DPI changes under MSW.
40+
- More generally, many fixes for various controls appearance in high DPI.
41+
- Long requested support for freezing rows and/or columns in wxGrid.
42+
- New XRC handlers for wxDataViewCtrl, wxInfoBar.
43+
- It is now possible to use gradients when creating wxGraphicsPen.
44+
- Extended compiler (MSVS 2019) and platforms (macOS 10.14+) support.
45+
- Significant improvements to the (still experimental) wxQt port.
46+
- Important bug fixes for focus handling in wxOSX port.
47+
48+
49+
Notice that in spite of all the changes, this release remains almost completely
50+
compatible with 3.1.2 at the API level, so upgrading to it if you're already
51+
using wxWidgets 3 should be straightforward.
3552

3653

3754
Changes since 3.0
@@ -41,13 +58,16 @@ Compared to the stable 3.0.x series, this version brings too many
4158
improvements and even more bug fixes to list them all, but here is the
4259
maximally condensed summary:
4360

44-
- Build system improvements: support for new compilers (MSVS 2017, g++ 8) and
45-
OS versions as well as an entirely new CMake build system.
61+
- Build system improvements: support for new compilers (up to MSVS 2019, g++ 9)
62+
with an even simpler way of using wxWidgets from MSVS, with wxwidgets.props
63+
file, and OS versions as well as an entirely new CMake build system.
64+
- Support for native dark mode under macOS 10.14 Mojave and later.
4665
- New features: support for mouse gesture events (GSoC 2017 project);
4766
fractional pen widths in wxGraphicsContext; arbitrary label windows in
4867
wxStaticBox; markup in wxDataViewCtrl items text; better support for high DPI
4968
monitors; support for ZIP 64 files; much improved accessibility support under
50-
MSW.
69+
MSW; Support for non-integer font sizes and arbitrary font weights; LZMA
70+
compression support (using liblzma)/
5171
- New classes: wxActivityIndicator, wxAddRemoveCtrl,
5272
wxAppProgressIndicator, wxNativeWindow, wxPowerResourceBlocker,
5373
wxSecretStore.
@@ -82,8 +102,8 @@ There is some support for the following platforms:
82102
* Most Unix variants with GTK+ 1.2
83103
* Most Unix variants with Qt 5 or newer (experimental)
84104

85-
Most popular C++ compilers are supported; see the install.txt file for each
86-
platform (following the links from docs/index.htm).
105+
All C++ compilers in common use are supported; see the install.txt file for
106+
each platform (following the links from docs/index.htm).
87107

88108

89109
Files
@@ -190,4 +210,4 @@ developed by its users and your contributions to it are always welcome!
190210

191211
Have fun!
192212

193-
The wxWidgets Team, December 2018
213+
The wxWidgets Team, October 2019

0 commit comments

Comments
 (0)