compat: document code in compat.h by fanquake · Pull Request #25493 · bitcoin/bitcoin

fanquake · 2022-06-28T16:46:17Z

Move compat.h into compat/, and document what is in there.

jamesob · 2022-06-28T19:19:49Z

Concept ACK

DrahtBot · 2022-06-29T00:34:37Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#23233 (BIP324: Add encrypted p2p transport {de}serializer by dhruv)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

vasild

ACK ae2db1c4764e2ab0e027c9526ba51c5330bb8b1e

vasild

ACK 5cb0589c2159c50d3f5d2f7b22287446a54a1070

fanquake · 2022-06-29T11:34:30Z

We will need to update the minisketch subtree, to accomodate the compat.h renaming, as the minisketch header, in the subtree, actually includes compat.h, when building for MSVC.

fanquake · 2022-06-29T13:48:33Z

For now I've rebased this on top of a minisketch subtree update, and a cherry-pick of bitcoin-core/minisketch#66; that way we'll get a run against the MSVC CI. I've also added a commit to use the SSIZE_T change in our code.

Once that PR is merged, I'll open a PR to update the subtree in our repo. Once that is merged, I'll rebase this.

28a28a0 Squashed 'src/minisketch/' changes from 7eeb778fef..47f0a2d26f (fanquake) Pull request description: Contains: * bitcoin-core/minisketch#65 * bitcoin-core/minisketch#66 Required for #25493. ACKs for top commit: achow101: ACK dc375e5 hebasto: ACK dc375e5, I have reviewed the code and it looks OK, I agree it can be merged. Tree-SHA512: fbcd6cdc551770ff67d1df65ab171ce43c9eb7e7668da76da5c5b06865ed550527abcff661741a86c1535018a85a165619ff94ae3e6c7a695374b6c4f843c5ca

28a28a0 Squashed 'src/minisketch/' changes from 7eeb778fef..47f0a2d26f (fanquake) Pull request description: Contains: * bitcoin-core/minisketch#65 * bitcoin-core/minisketch#66 Required for bitcoin#25493. ACKs for top commit: achow101: ACK dc375e5 hebasto: ACK dc375e5, I have reviewed the code and it looks OK, I agree it can be merged. Tree-SHA512: fbcd6cdc551770ff67d1df65ab171ce43c9eb7e7668da76da5c5b06865ed550527abcff661741a86c1535018a85a165619ff94ae3e6c7a695374b6c4f843c5ca

vasild

ACK 18ce5f990d7a2ae5815d09c87be5db7f5d86c1e7

vasild

ACK bdbdfe074b7c54268ec813f5092ce722d6cc5899

vasild

ACK 122c242cae6e459ab58f2ef0ef53e2f8db6fa363

hebasto

ACK 122c242cae6e459ab58f2ef0ef53e2f8db6fa363

The S_IRUSR and S_IWUSR macro are used in src/wallet/bdb.cpp which requires to #include <compat/compat.h>. Maybe #include <sys/stat.h> could be moved from src/wallet/bdb.cpp into compat/compat.h as well.

fanquake · 2022-07-20T09:47:42Z

Maybe #include <sys/stat.h> could be moved from src/wallet/bdb.cpp into compat/compat.h as well.

Rebased and incorporated this change.

vasild · 2022-07-20T11:21:52Z

I would expect non-standard headers to be included in compat.h (inside some #ifdef magic) and then other source files to include compat.h. This implies that a non-standard header is included only in compat.h. sys/stat.h is included in 5 files (in httpserver.cpp without #ifdef 👀). Should all of those be replaced with #include <compat.h>?

compat.h is included in 27 files. Now all of them (indirectly) include sys/stat.h.

The commit message of 3a865ea692cc46a68816dbd84f7254f4390a4f42 compat: document S_I* defines when building for Windows needs to be extended because now the commit does more than mentioned.

See: https://docs.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2

See: https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types#ssize_t https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_types.h.html

fanquake · 2022-07-20T12:11:36Z

Ok. I've just reverted Hebastos suggestion for now. If someone wants to go an massage the headers later (with IWYU), they can. However doing that is unrelated to adding documentation.

vasild

ACK f7dc992

hebasto

re-ACK f7dc992

fanquake commented Jun 28, 2022

View reviewed changes

Comment thread src/compat/compat.h Outdated

fanquake force-pushed the document_compat_code branch 3 times, most recently from f558168 to ae2db1c Compare June 28, 2022 17:11

DrahtBot added the Refactoring label Jun 28, 2022

This was referenced Jun 29, 2022

refactor: add most of src/util to iwyu #25324

Merged

refactor: Introduce EvictionManager #25268

Closed

vasild approved these changes Jun 29, 2022

View reviewed changes

Comment thread src/random.cpp Outdated

Comment thread src/compat/compat.h Outdated

fanquake force-pushed the document_compat_code branch from ae2db1c to 5cb0589 Compare June 29, 2022 11:05

vasild approved these changes Jun 29, 2022

View reviewed changes

fanquake force-pushed the document_compat_code branch from 5cb0589 to a43777b Compare June 29, 2022 13:48

fanquake mentioned this pull request Jun 29, 2022

msvc: remove direct Bitcoin Core compat.h include bitcoin-core/minisketch#66

Merged

DrahtBot mentioned this pull request Jun 29, 2022

refactor: Move inbound eviction logic to its own translation unit #25500

Merged

fanquake mentioned this pull request Jun 29, 2022

upstream: update minisketch subtree #25502

Merged

fanquake force-pushed the document_compat_code branch from a43777b to 18ce5f9 Compare June 30, 2022 08:08

fanquake marked this pull request as ready for review June 30, 2022 08:08

DrahtBot mentioned this pull request Jul 1, 2022

BIP324: Add encrypted p2p transport {de}serializer #23233

Closed

fanquake requested a review from vasild July 4, 2022 16:45

vasild approved these changes Jul 5, 2022

View reviewed changes

luke-jr reviewed Jul 5, 2022

View reviewed changes

Comment thread src/compat/compat.h Outdated

fanquake force-pushed the document_compat_code branch from 18ce5f9 to bdbdfe0 Compare July 6, 2022 10:13

vasild approved these changes Jul 6, 2022

View reviewed changes

DrahtBot added the Needs rebase label Jul 7, 2022

fanquake force-pushed the document_compat_code branch from bdbdfe0 to 122c242 Compare July 13, 2022 10:14

vasild approved these changes Jul 13, 2022

View reviewed changes

DrahtBot mentioned this pull request Jul 13, 2022

refactor: Introduce EvictionManager and use it for the inbound eviction logic #25572

Closed

DrahtBot removed the Needs rebase label Jul 13, 2022

fanquake requested review from hebasto, jamesob and laanwj July 13, 2022 12:24

hebasto approved these changes Jul 20, 2022

View reviewed changes

fanquake added 4 commits July 20, 2022 10:34

refactor: move compat.h into compat/

cc7b2fd

compat: document FD_SETSIZE redefinition for WIN32

7c3df5e

compat: remove unused WSA* definitions

b63ddb7

compat: extract and document MAX_PATH

203e682

fanquake force-pushed the document_compat_code branch from 122c242 to 56470a1 Compare July 20, 2022 09:47

fanquake added 4 commits July 20, 2022 13:10

compat: document S_I* defines when building for Windows

fb6db6f

compat: document sockopt_arg_type definition

3f1d2fb

compat: document error-code mapping

3be7ee7

See: https://docs.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2

compat: document redefining ssize_t when using MSVC

f7dc992

See: https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types#ssize_t https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_types.h.html

fanquake force-pushed the document_compat_code branch from 56470a1 to f7dc992 Compare July 20, 2022 12:11

vasild approved these changes Jul 20, 2022

View reviewed changes

hebasto approved these changes Jul 20, 2022

View reviewed changes

maflcko merged commit 5c82ca3 into bitcoin:master Jul 20, 2022

fanquake deleted the document_compat_code branch July 20, 2022 15:27

sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Jul 20, 2022

Merge bitcoin#25493: compat: document code in compat.h

224670e

bitcoin locked and limited conversation to collaborators Jul 20, 2023

Conversation

fanquake commented Jun 28, 2022

Uh oh!

Uh oh!

jamesob commented Jun 28, 2022

Uh oh!

DrahtBot commented Jun 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Conflicts

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

fanquake commented Jun 29, 2022

Uh oh!

fanquake commented Jun 29, 2022

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

hebasto left a comment

Choose a reason for hiding this comment

Uh oh!

fanquake commented Jul 20, 2022

Uh oh!

vasild commented Jul 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fanquake commented Jul 20, 2022

Uh oh!

vasild left a comment

Choose a reason for hiding this comment

Uh oh!

hebasto left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

DrahtBot commented Jun 29, 2022 •

edited

Loading

vasild commented Jul 20, 2022 •

edited

Loading