Commit Graph

50 Commits

Author SHA1 Message Date
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
Catalin
35b4c82f18 Add libexpat upgrade example for MSW. 2017-02-02 02:18:02 +02:00
Catalin
7f54eba05c Define PNG_ZLIB_VERNUM as 0. 2017-01-07 01:12:11 +02:00
Catalin
72971d3329 Add libpng upgrade example for MSW. 2017-01-06 18:16:00 +02:00
Danny Scott
059704edc1 Update instructions for producing official MSW binaries
Simplify the officialbuild.bat script by only checking for "vcXX" instead of
accepting both them and "vsYYYY".

Also add instructions for using it in the corresponding HOWTO.

Closes #17514.
2016-07-02 14:54:16 +02:00
Dimitri Schoolwerth
392a2f17a9 Add some notes to how-to-release.md 2016-06-06 03:17:23 +04:00
Vadim Zeitlin
cbb799b1ae Updates for 3.1.0 release
Update dates, changes descriptions and release preparation instructions.
2016-02-28 22:33:37 +01:00
Bryan Petty
c6b744facb Clarify location of built release packages. 2015-11-15 21:31:38 -07:00
Bryan Petty
f8f531687c Release script improvements. 2015-11-15 13:56:52 -07:00
Bryan Petty
0b2263c25d Updated links and mailing list addresses. 2015-10-30 20:06:09 -06:00
Bryan Petty
89b0692fff Updated release instructions with requirements. 2015-10-30 00:34:44 -06:00
Bryan Petty
7c6c21c538 Bump Doxygen version used in docs. 2015-09-24 17:42:08 -06:00
Dimitri Schoolwerth
31145b8e3a Fix some typos, no code changes (besides strings) 2015-06-05 02:54:46 +04:00
Dimitri Schoolwerth
6be7e28199 Change a reference to a doc section
Refer to a section by (partial) name instead of indexed number (a
leftover from before these docs were changed to use markdown).
2015-05-31 03:04:02 +04:00
Bryan Petty
dd4c208148 Update release scripts and docs to reflect .gitattributes use.
It is no longer required to use svn-find-native-eols.pl now that
.gitattributes are in place to ensure correct EOLs in various files.

Closes #15584
2015-03-17 13:47:43 -06:00
Bryan Petty
29eb2a71c0 Update SVN references to git, mostly in docs. 2015-02-20 20:07:15 -07:00
Bryan Petty
6d16ff35c6 Turn off batchmode for PDF manual, and no longer update latex_header.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78456 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2015-02-08 11:17:35 +00:00
Vadim Zeitlin
2df4b4505e Update release instructions to mention tagging the release.
Also remove the reference to the non-existing "next section" and a couple of
other minor changes.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@77990 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-10-11 16:29:29 +00:00
Vadim Zeitlin
46f44e1c0c Add a reminder to update the date on download page to release HOWTO.
This is probably useful as it was forgotten for 3.0.1.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-17 14:39:30 +00:00
Vadim Zeitlin
c9220befc7 Remove the old release making instructions and scripts.
Using git-based scripts seems to work well and the old scripts are not
maintained any more and having several ways of making releases is just
confusing, so leave only one set of scripts, the one actually used since
2.9.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76710 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-15 01:33:33 +00:00
Vadim Zeitlin
e96b28181c Convert contributors documentation to markdown.
The conversion is very superficial and there are probably many problems in the
Markdown rendering, but this is the first step towards making these documents
more readable when viewing them online.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76690 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-11 21:14:09 +00:00
Vadim Zeitlin
4ce8a5ed00 Rename tech notes to files with reasonable names.
Keep the old files to avoid breaking existing links to them, but just point to
the files in the new contributing subdirectory with more meaningful names now.

Also remove a couple of long obsolete tech notes.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76689 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-06-11 21:14:02 +00:00