Commit Graph

100 Commits

Author SHA1 Message Date
Vadim Zeitlin
5b89b4ae7a Update release instructions for 3.2 branch
Notably remove the confusing reference to updating the changelog which
doesn't apply to this branch.
2023-02-08 23:44:55 +01:00
Lauri Nurmi
3967bd9e97 Fix more double negatives used with 'neither'
In many cases it should be 'either'.

No changes to actual code.

Complements #22723, which focused on API docs and comments in C++ code.

Co-authored-by: Ian McInerney <ian.s.mcinerney@ieee.org>

See #22798.

(cherry picked from commit 969b1fad4c15a17784bd4c2af6477e9d3cffc92e)
2022-09-18 18:02:59 +02:00
Vadim Zeitlin
25c7319fe9 Update the instructions for creating releases on GitHub
Explain how to use the new workflow to automate even more parts of the
release process.

(cherry picked from commit dd50c77a880d587fa9e71bba8fd0114d1f6dbce1)
2022-09-15 18:47:31 +02:00
Vadim Zeitlin
93577ce1b3 Add CI workflow checking ABI stability
Add the ABI files generated by libabigail abidw tool (note that
--no-corpus-path --no-comp-dir-path options were used to avoid having
system-specific object file paths in these files and the source file
paths were edited to remove the system-specific prefix from them too)
and a script comparing the current ABI with these files.

Also update the documentation to describe using libabigail tools as
abi-compliance-checker doesn't seem to work under the recent systems any
longer: it gives some warnings and doesn't detect ABI-incompatible
changes.

Closes #22634.
2022-07-17 17:19:02 +02:00
Vadim Zeitlin
525d55a0f5 Document that major and minor versions must be updated manually
We probably could change inc_release to do this too, but considering the
frequency of our minor (let alone major) releases, it doesn't seem to be
worth it.
2022-06-27 18:37:12 +02:00
Vadim Zeitlin
1f32fe4d3b Avoid using TAB for indent in a HOWTO 2022-06-21 00:55:30 +02:00
Vadim Zeitlin
cb7cefcc87 Update the required wx versions in the sample CMakefile
Also add this file to the list of files to update.
2022-06-21 00:55:25 +02:00
Vadim Zeitlin
03293ae8e2 Update release documents for 3.2.0
The main change is that it's now described as the new stable release and
not a development one any more.
2022-06-21 00:54:26 +02:00
Vadim Zeitlin
079e608cb5 Remind to update zconf.h when upgrading zlib
And upgrade the submodule after performing the change documented here in
it to avoid link conflicts between the bundled zlib version and another
copy of zlib potentially used in the application due to the name clashes
between crc32_combine_xxx functions new in 1.2.12 that upstream forgot
to add to zconf.h.

Closes #22280.
2022-04-20 19:48:10 +02:00
Vadim Zeitlin
d8f346cecc Reorganize the 3rd party libraries update HOWTO more logically
Put steps in the chronological order.

Also put library-specific instructions in the same section, but in
different subsections instead of combining 2 of them in one section and
having a separate section for another one as before.
2022-04-20 19:43:49 +02:00
Vadim Zeitlin
1415830741 Fix section headings in 3rd party libraries upgrading HOWTO
Using numbers prevented the headings from being interpreted as such and
we instead got numbered item followed by a horizontal separator when
rendering Markdown as HTML.

Just remove the numbers to fix this.
2022-04-20 19:34:03 +02:00
Vadim Zeitlin
bdad37f278 Add translations update to the pre-release list of things to do
Remind that a request to update translations should be sent to the
translators mailing list.
2022-04-09 22:51:25 +02:00
Vadim Zeitlin
4da102f2b1 Remove mention of Trac milestones from the release instructions
Replace it with the GitHub milestones update step instead.

There is no reason to create a new version any more.
2022-04-04 20:28:41 +01:00
Vadim Zeitlin
85c8c8987e Minor docs-related updates to the release instructions
Remove the instructions for applying the cherry-picked commit on
docs.wxwidgets.org as it's not used any more.

These instructions are probably insufficiently detailed, but we'll
probably switch to using GitHub Actions for updating the documentation
soon, so they won't be necessary for much longer anyhow and it's not
worth expanding them.
2022-04-04 17:41:05 +01:00
Vadim Zeitlin
2f0bce2979 Replace old Trac links with GitHub ones
Also update a couple of links to SF.
2022-01-13 16:52:58 +01:00
Vadim Zeitlin
64ad6933b5 Document that bakefiles need to be updated for a new MSVS version 2021-12-18 20:14:09 +01:00
Vadim Zeitlin
a65e5f4c1d Explain better how to add data files to a sample
Also don't duplicate this information in both how-to-add-new-sample.md
and how-to-add-files-to-build-system.md, just reference the former in
the latter instead.

Also fix some Markdown markup.
2021-11-29 13:58:52 +01:00
Maarten Bent
e917c8c6a7 Also explain how to build the tests using CMake 2021-11-12 16:53:30 +01:00
Vadim Zeitlin
46973762ba Explain how to build the tests
It may not be obvious how to build the tests, so add a section
explaining this to the existing file containing the instructions about
writing the tests and add a README to the tests directory itself to
increase chances that this file will be found -- hopefully anybody
interested in the tests will look at the README in the directory
containing them.
2021-11-12 14:21:41 +01:00
PB
d7e33a5291 Extend wxMSW contributor guide
List useful wrapper classes for Windows API provided by wxWidgets.

Closes https://github.com/wxWidgets/wxWidgets/pull/2578
2021-11-05 13:56:10 +01:00
Vadim Zeitlin
5a6109fdce Mention support for MSVS 2022 in the documentation
Note that this support is still incomplete, notably we don't have
*_vc17.sln files yet and the official build scripts haven't been updated
to build MSVS 2022 binaries neither.
2021-08-26 00:04:28 +02:00
Vadim Zeitlin
bb767e0ebc Remove apparently unused Info.plist in docview sample
Only Info.plist.in is used by configure and it doesn't hardcode the
version, so there is no need to update it there.
2021-08-15 16:56:24 +02:00
Maarten Bent
c85a6bc4e4 Mention CMake in library naming convention documentation 2021-06-22 21:42:03 +02:00
Maarten Bent
01edac992d Update library naming convention documentation 2021-06-06 22:25:23 +02:00
Vadim Zeitlin
e539cb69bb Remove platform-specific translations support
As shown by the fact that no other platform-specific translations were
ever added since the initial version of locale/msw/it.po added way back
in 4d931bcca0 (Translate '&Help' to '&' for italian Windows only,
2005-08-12), this is not especially useful, so just handle this
particular case specially in wxGetStockLabel() and remove support for
platform-specific translations.

This allows to simplify the makefiles and the catalog loading code as
there is no need to deal with the files in subdirectories any more.
2021-02-07 00:06:21 +01:00
Vadim Zeitlin
7169056e91 Use Markdown formatting in the translation HOWTO
Also update Poedit name (case) and URL and remove thoroughly obsolete
references to 4DOS.
2021-01-21 15:56:18 +01:00
Vadim Zeitlin
eae08b14c6 Amend the update schedule frequency from the last commit
Even if wxstd.pot is updated infrequently now, we shouldn't document
this as something normal or desirable.
2021-01-21 15:50:02 +01:00
Lauri Nurmi
f7514362ba More accurately describe wxstd.pot update schedule
Git log shows that wxstd.pot was not updated at all in e.g. 2020,
2019, 2018, 2016.
2021-01-21 13:45:00 +02:00
Lauri Nurmi
b78c61af84 Translation docs update: don't recommend 20-year-old gettext; use msginit
Warning about gettext versions earlier than 0.10.35 is pointless,
as even 0.10.35 is from 2001, and so old it isn't even available
on GNU mirrors anymore. We shall not recommend a specific version in
the first place.

The proper way to start a new translation is to use msginit to initialize
a .po file -- just copying the .pot leaves many fields to their default
values, which the translator would need to fill in manually (the
Plural-Forms: field in particular).
2021-01-21 13:42:22 +02:00
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