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 Windows install notes for build options #4545

Closed
SLDiggie opened this issue Oct 30, 2019 · 2 comments
Labels

Comments

@SLDiggie
Copy link

@SLDiggie SLDiggie commented Oct 30, 2019

There are notes for building for Windows in a couple of places:

https://curl.haxx.se/docs/install.html
/docs/INSTALL.md

Each place lists what I think may be an incomplete set of definitions for customizing the build. Trawling through a few headers, it looks like a more complete list of options (for non-special cases) might be something like this:

HTTP_ONLY
CURL_DISABLE_FTP
CURL_DISABLE_LDAP
CURL_DISABLE_LDAPS
CURL_DISABLE_TELNET
CURL_DISABLE_DICT
CURL_DISABLE_FILE
CURL_DISABLE_TFTP
CURL_DISABLE_HTTP
CURL_DISABLE_RTSP
CURL_DISABLE_POP3
CURL_DISABLE_IMAP
CURL_DISABLE_SMTP
CURL_DISABLE_GOPHER
CURL_DISABLE_SMB
CURL_DISABLE_NTLM
CURL_DISABLE_VERBOSE_STRINGS
CURL_DISABLE_COOKIES

It would be nice to have at least the two aforementioned docs updated with supported options.

@bagder

This comment has been minimized.

Copy link
Member

@bagder bagder commented Oct 31, 2019

There are even more CURL_DISABLE_* defines that can be set to disable specific parts of curl when building. They all have their own configure options. I wouldn't mind having somewhere to document what they're used for and we could then also generate the list or have a test case verify that the list contains all the used DISABLE defines. But maybe that place isn't in the Windows build section in INSTALL.md since these are not really Windows-specific...

@SLDiggie

This comment has been minimized.

Copy link
Author

@SLDiggie SLDiggie commented Oct 31, 2019

A more comprehensive, better documented list would be fantastic. I mentioned Windows because the existing documentation refers to some of these, and because mechanisms for customizing the build for Windows are more limited, thus it's of even greater importance that a Windows developer has a comprehensive list. However, I agree that a centralized reference would be ideal, and then perhaps the Windows build notes/docs can simply point there.

bagder added a commit that referenced this issue Nov 11, 2019
The disable-scan script used in test 1165 is extended to also verify
that the docs cover all used defines and all defines offered by
configure.

Reported-by: SLDiggie on github
Fixes #4545
@bagder bagder closed this in cbaaae4 Nov 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.