Commit Graph

71 Commits

Author SHA1 Message Date
PB
f0ee18f1aa Remove BCC mentions from documentation 2020-10-13 18:49:53 +02:00
Vadim Zeitlin
47a168eaa2 Fix build/bakefiles/version.bkl path in the release instructions
Wrong directory was used.
2020-07-23 16:22:58 +02:00
Vadim Zeitlin
2fed4334a1 Remove the item about updating non-existing wxTrac query
There is no "Tickets to be fixed for the next release" query, so no need
to update it.
2020-07-23 16:16:42 +02:00
Vadim Zeitlin
8df2acf10d Mention Cloudflare caching in the release instructions
This is mostly for my own sake as I keep being surprised by not seeing
the changes done on the server in the browser.
2020-07-22 18:19:54 +02:00
Vadim Zeitlin
3c259eb56d Document change log update better in the release instructions
Also remove the part about updating version.bkl from the pre-release
section, as this is done after the release.

As this leaves only 2 items in the numbered list of the things to do,
remove the list entirely.
2020-07-22 01:19:28 +02:00
Vadim Zeitlin
f03878251b Also fix spelling mistakes in the documentation files
Run the same codespell command on docs directory.
2020-06-28 15:30:04 +02:00
Danny Scott
b424ac6fe9 Update how-to-release instructions
Document bakefile version needed and the commands for regenerating the
files generated by it.

Also update instructions for changing C:R:A values.

Closes https://github.com/wxWidgets/wxWidgets/pull/1838
2020-05-06 01:47:34 +02:00
Vadim Zeitlin
7a56a200bf Remove the mention of update_release_info.rb from release HOWTO
This is now done automatically in the GitHub action of wxWidgets/website
repository.

Do mention that rebuilding the web site requires the release to be
available.
2020-04-28 00:53:06 +02:00
Vadim Zeitlin
a98410504b Document updating docs.wxwidgets.org for the releases
[skip ci]

Closes https://github.com/wxWidgets/wxWidgets/pull/1823
2020-04-26 16:33:51 +02:00
PB
53df59a14a Add wxTrac-related instruction to how-to-release.md
Note that the version for the next release must be
increased in wxTrac example queries.

Closes https://github.com/wxWidgets/wxWidgets/pull/1692
2020-01-06 01:05:39 +01:00
Vadim Zeitlin
8a40d23b27 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.
2019-10-27 18:41:42 +01:00
Danny Scott
0a8cb849b5 Update to reflect use of vc14x binary in place of vc14[012]
Closes https://github.com/wxWidgets/wxWidgets/pull/1608
2019-10-19 20:08:01 +02:00
Vadim Zeitlin
29781b1752 Update bakefile-related information in the docs
Mention that we use the legacy 0.2 bakefile branch.

Also use https://www.bakefile.org/ as Bakefile home page location.

Finally, use backticks around more files names, especially those
containing asterisks, that break Markdown syntax highlighting in Vim
otherwise.
2019-10-06 23:14:43 +02:00
Danny Scott
191aa30222 Update "MSVC binaries" section of the release build instructions
Reflect currently used versions.

Closes https://github.com/wxWidgets/wxWidgets/pull/1569
2019-09-29 17:34:08 +02:00
Vadim Zeitlin
ff285aa5b6 Add docs/msw/binaries.md to the list of files to update
This file contains the version of the library.
2019-09-18 02:19:13 +02:00
PB
60dbb7d5bd Correct the tool path in docs/contributing/how-to-release.md
Correct the name and path of the batch file used to build
official MSVS binaries.
2019-09-17 19:53:06 +02:00
PB
698c0c09ae Update docs/contributing/binary-compatibility.md
Attempt to update the document, some parts of it are still
quite outdated (references to Sun/Solaris, ancient GCC and
wxWidgets version...).
2019-09-17 19:07:22 +02:00
Vadim Zeitlin
72272f5901 Document that 3rd person verb forms should be used in the manual
See https://github.com/wxWidgets/wxWidgets/pull/1473
2019-08-20 17:16:53 +02:00
Vadim Zeitlin
fbe651731c Fix problems with documentation HOWTO syntax highlighting
Use backticks to prevent "_" and "*" from being interpreted as special
Markdown characters.

No real changes.
2019-08-20 17:11:37 +02:00
Vadim Zeitlin
53f40b5029 Update comment and documentation related to C4535 MSVC warning
Update the compiler version in the comment and explain how/when to
update it in the future.
2019-07-13 16:31:19 +02:00
Vadim Zeitlin
0c64345890 Add instructions for adding support for new MSVS version
Try to collect all the information in a single place to make things
easier for the next update.
2019-07-07 15:32:33 +02:00
Artur Wieczorek
1965ca4296 Update doxygen readme about Graphviz
Mention that Graphviz visualization software is also required to generate
documentation properly.
2019-05-18 09:59:24 +02:00
Artur Wieczorek
fea3027488 Update reference to non-reachable website in doxygen readme file
Current website URL is no longer reachable so replace it with new one which
seems to refer to the same topic.
2019-05-18 09:41:18 +02:00
Vadim Zeitlin
61b2136bee Prettify instructions for adding a new wxUSE_XXX constant
Improve translation of the file from plain text to (GitHub-flavoured)
Markdown.
2019-01-10 03:46:12 +01:00
Vadim Zeitlin
cf28473d9f Mention that wx.bkl doesn't need to be updated for micro releases
Only WX_VERSION_DEFAULT value, which doesn't include the micro version
component, needs to be updated in this file.
2018-12-10 19:06:18 +01:00
Vadim Zeitlin
c0cb5cacd9 Don't try updating version in non-existent docs/msw/install.txt
This file doesn't exist any more and install.md which replaced it
doesn't contain any references to the version.
2018-12-10 19:06:18 +01:00
Vadim Zeitlin
d8a41187ed Update "How to make releases" instructions
Remove update steps for wxBlog (because it's redundant with the news
post on www.wxwidgets.org now that both are hosted at the same site),
Google+ (because of its extinction) and Buildbot (because we're going to
stop using it soon anyhow).

Add a step for updating the list of compilers used for building
binaries.
2018-12-10 18:35:48 +01:00
Vadim Zeitlin
edbee125f9 Slightly improve instructions for updating docs/release.md
It makes more sense to update it manually once and then run the script
rather than partially updating it manually first, then updating it again
and then running the script.
2018-12-09 16:55:42 +01:00
Maarten Bent
4ddd4cc68d Improve updating third party library documentation
Add a section about updating the build files.
2018-11-17 19:08:43 +01:00
Tobias Taschner
d433aa7821
Include CMake in how to add new sample docs 2018-10-24 10:37:52 +02:00
Tobias Taschner
2ad0c1b7e1
Include CMake in how to add wxUSE_ documentation 2018-10-24 10:30:49 +02:00
Tobias Taschner
4b8dee1066 Update where to post in "How to release" documentation 2018-10-10 13:59:28 +02:00
Tobias Taschner
fe9f25c7ce Add download update instructions "how to release" documentation 2018-10-10 13:58:23 +02:00
Bryan Petty
f4b0ae0370 Update docs.wxwidgets.org links to HTTPS. 2018-09-02 15:35:48 -06:00
Vadim Zeitlin
7fdd446cc8 Remove a reference to Info_carbon.plist
This file was removed in 5ba67c67e4 so
don't tell people to update it when changing version.
2018-05-02 16:01:36 +02:00
Vadim Zeitlin
ff06e12ceb Remove unused and outdates samples/Info.plist file
This file was added in 4d524cdd0e a long
time ago but doesn't seem to have been ever actually used for anything
and is outdated, e.g. contains LSRequiresCarbon=true, which shouldn't be
used any longer.

Remove the file itself and all references to it.
2018-05-02 16:01:02 +02:00
Danny Scott
5e61527c04 Fix typos and shell syntax in the release instructions
Closes #18095.
2018-02-28 18:48:52 +01:00
Vadim Zeitlin
4e5904a4cc Remove unused buildbot XML configuration files
Buildbot configuration was redone in pure Python (see master.cfg in
https://github.com/wxWidgets/buildbot repository) since several years
already, there is no need to keep these obsolete files.
2018-02-20 14:49:50 +01:00
Vadim Zeitlin
35d2823601 Tweak post-release script and documentation
For the release candidates, allow passing the version (e.g. "3.1.1-rc")
to post-release.sh on the command line and document this.

Also don't commit automatically, this is annoying, especially as the
script doesn't check for errors.

Finally, fix the problem with the CHM file name: it must be zipped,
presumably to avoid problems with some firewalls blocking downloading
CHM files (as there is really no advantage in compressing the already
compressed CHM file otherwise).
2018-02-05 15:44:19 +01:00
Vadim Zeitlin
7fd25de661 Update release script to include submodules in the archives
Use "git submodule foreach" to run "git archive" in all of the
submodules as well.

Also document the requirement to have GNU tar which is needed to be able
to successfully extract several concatenated tar archives.
2017-11-16 23:37:24 +01:00
Cătălin Răceanu
45c33d2a17 Add scripts for automating more parts of the release process
Update dates in various files before the release automatically.

Also automatically update SHA-1 of the release files both before the
release (to zero them) and afterwards (to use the correct values).

Closes https://github.com/wxWidgets/wxWidgets/pull/443
2017-11-16 18:45:17 +01:00
Vadim Zeitlin
e35f01384f Merge branch 'jpeg-submodule'
Switch to using submodule and update the library version.
2017-11-12 17:43:22 +01:00
Vadim Zeitlin
03c81535ab Replace tiff subdirectory with a Git submodule
Try to preserve most of the manual changes done to libtiff sources in
wxWidgets, dropping just some VC6-specific workarounds which are not
needed any more.
2017-11-11 23:39:00 +01:00
Vadim Zeitlin
824134d427 Replace Expat sources directory with a Git submodule
This will make it simpler to track upstream in the future.
2017-11-11 20:50:50 +01:00
Vadim Zeitlin
e1c54ff032 Update 3rd party libraries updating instructions
Explain how to do it now when Git submodules are used for them instead
of speaking about svn vendor branches.
2017-11-11 15:35:35 +01:00
Vadim Zeitlin
617250bc11 Upgrade libpng to 1.6.34
Upgrade src/png submodule to the latest library version and slightly
update its upgrade instructions.
2017-11-11 14:13:30 +01:00
Vadim Zeitlin
d78b7d2f27 Fix a typo in Catch tutorial link
No real changes.
2017-11-02 01:53:27 +01:00
Vadim Zeitlin
e70fc11ef1 Replace CppUnit with Catch for unit tests
Drop the legacy CppUnit testing framework used for the unit tests.
Replacing it with Catch has the advantage of not requiring CppUnit
libraries to be installed on the system in order to be able to run
tests (Catch is header-only and a copy of it is now included in the
main repository itself) and, in the future, of being able to write
the tests in a much more natural way.

For now, however, avoid changing the existing tests code as much as
[reasonably] possible to avoid introducing bugs in them and provide
the CppUnit compatibility macros in the new wx/catch_cppunit.h header
which allow to preserve the 99% of the existing code unchanged. Some
of the required changes are:

 - Decompose asserts using "a && b" conditions into multiple asserts
   checking "a" and "b" independently. This would have been better
   even with CppUnit (to know which part of condition exactly failed)
   and is required with Catch.

 - Use extra parentheses around such conditions when they can't be
   easily decomposed in the arrays test, due to the use of macros.
   This is not ideal from the point of view of messages given when
   the tests fail but will do for now.

 - Rewrite asserts using "a || b" as a combination of condition
   checks and assert macros. Again, this is better anyhow, and is
   required with Catch. Incidentally, this allowed to fix a bug in
   the "exec" unit test which didn't leave enough time for the new
   process to be launched before trying to kill it.

 - Remove multiple CPPUNIT_TEST_SUITE_NAMED_REGISTRATION() macros,
   our emulation of this macro can be used only once.

 - Provide string conversions using Catch-specific StringMaker for
   a couple of types.

 - Replace custom wxImage comparison with a Catch-specific matcher
   class.

 - Remove most of test running logic from test.cpp, in particular don't
   parse command line ourselves any longer but use Catch built-in
   command line parser. This is a source of a minor regression:
   previously, both "Foo" and "FooTestCase" could be used as the name of
   the test to run, but now only the latter is accepted.
2017-11-02 01:53:16 +01:00
Bryan Petty
ed173ed91e Use HTTPS with Trac links. 2017-07-04 13:15:14 -06:00
Vadim Zeitlin
d10c600773 Add instructions for checking ABI compatibility to release HOWTO
Explain how to use abi-compliance-checker.
2017-04-22 15:58:13 +02:00