mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-01-24 13:55:42 +08:00
Code Issues Packages Projects Releases Wiki Activity
f8dd5869bc
openssl/doc
History
Dr. Matthias St. Pierre f8dd5869bc doc/man3/SSL_set_fd.pod: add note about Windows compiler warning 
According to an old stackoverflow thread [1], citing an even older comment by
Andy Polyakov (1875e6db29, Pull up Win64 support from 0.9.8., 2005-07-05),
a cast of 'SOCKET' (UINT_PTR) to 'int' does not create a problem, because although
the documentation [2] claims that the upper limit is INVALID_SOCKET-1 (2^64 - 2),
in practice the socket() implementation on Windows returns an index into the kernel
handle table, the size of which is limited to 2^24 [3].

Add this note to the manual page to avoid unnecessary roundtrips to StackOverflow.

[1] https://stackoverflow.com/questions/1953639/is-it-safe-to-cast-socket-to-int-under-win64
[2] https://docs.microsoft.com/en-us/windows/win32/winsock/socket-data-type-2
[3] https://docs.microsoft.com/en-us/windows/win32/sysinfo/kernel-objects

Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16699)
2021-09-30 14:03:16 +02:00
..
HOWTO
images
internal doc: Fix include syntax 2021-09-22 18:55:34 +10:00
life-cycles doc: remove end of line whitespace 2021-09-22 16:22:50 +10:00
man1 Update manual to reference the IANA TLS Cipher Suites Registry 2021-09-30 12:20:01 +02:00
man3 doc/man3/SSL_set_fd.pod: add note about Windows compiler warning 2021-09-30 14:03:16 +02:00
man5 doc: remove end of line whitespace 2021-09-22 16:22:50 +10:00
man7 doc: note that these KDFs require the legacy provider to be available 2021-09-28 18:08:42 +10:00
build.info doc: include PVK KDFdocumentation in build.info 2021-09-28 18:08:42 +10:00
build.info.in doc: remove end of line whitespace 2021-09-22 16:22:50 +10:00
dir-locals.example.el
fingerprints.txt Update fingerprints.txt 2021-07-29 14:09:55 +01:00
openssl-c-indent.el
perlvars.pm
README.md

README.md

OpenSSL Documentation

README.md This file

fingerprints.txt PGP fingerprints of authorised release signers

standards.txt standards.txt Moved to the web, https://www.openssl.org/docs/standards.html

HOWTO/ A few how-to documents; not necessarily up-to-date

man1/ The openssl command-line tools; start with openssl.pod

man3/ The SSL library and the crypto library

man5/ File formats

man7/ Overviews; start with crypto.pod and ssl.pod, for example Algorithm specific EVP_PKEY documentation.

Formatted versions of the manpages (apps,ssl,crypto) can be found at https://www.openssl.org/docs/manpages.html