Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to acknowledge integer type mismatch in certain admin packets #8238

Merged

Conversation

@duckfullstop
Copy link
Contributor

duckfullstop commented Jun 26, 2020

The packets ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY and ADMIN_PACKET_ADMIN_POLL call for an AdminUpdateType of uint16 and uint8 respectively, which doesn't make any sense.

As far as I can tell looking at blame, this has been the case since day 1 of this being introduced, so changing it to be consistent across the two packet types would break literally everybody's implementations regardless of which way around you did it.

I have discussed this mismatch in IRC, and this documentation change seems to be the sanest way forward - at the very least it's a warning to those implementing these packets to watch out for.

… AdminUpdateType
@glx22 glx22 merged commit 1bc7047 into OpenTTD:master Jun 27, 2020
8 checks passed
8 checks passed
Commit checker
Details
OpenTTD CI Build #20200626.6 succeeded
Details
OpenTTD CI (Linux linux-amd64-clang-3.9) Linux linux-amd64-clang-3.9 succeeded
Details
OpenTTD CI (Linux linux-amd64-gcc-6) Linux linux-amd64-gcc-6 succeeded
Details
OpenTTD CI (Linux linux-i386-gcc-6) Linux linux-i386-gcc-6 succeeded
Details
OpenTTD CI (MacOS) MacOS succeeded
Details
OpenTTD CI (Windows Win32) Windows Win32 succeeded
Details
OpenTTD CI (Windows Win64) Windows Win64 succeeded
Details
@techgeeknz
Copy link
Contributor

techgeeknz commented Jun 30, 2020

As far as I can tell looking at blame, this has been the case since day 1 of this being introduced, so changing it to be consistent across the two packet types would break literally everybody's implementations regardless of which way around you did it.

Good work, @duckfullstop. It's no longer a bug; it's now a feature 😆!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.