php / php/doc-en

On various parameters, default value not coherent with library

Open
#1,700 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Extension: curl
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

From manual page: https://php.net/function.curl-setopt


CURLOPT_CONNECTTIMEOUT:
Explanation reads 'Use 0 to wait indefinitely' while cURL site (https://curl.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html) says 'Set to zero to switch to the default built-in connection timeout - 300 seconds'
CURLOPT_CONNECTTIMEOUT_MS:
Explanation reads 'Use 0 to wait indefinitely' while cURL site (https://curl.se/libcurl/c/CURLOPT_CONNECTTIMEOUT_MS.html) says 'Set to zero to switch to the default built-in connection timeout - 300 seconds'
CURLOPT_DNS_CACHE_TIMEOUT:
Explanation reads 'This option is set to 120 (2 minutes) by default' while cURL site (https://curl.se/libcurl/c/CURLOPT_DEFAULT_PROTOCOL.html) says 'By default, libcurl caches this info for 60 seconds'
CURLOPT_DNS_USE_GLOBAL_CACHE:
Lacks a warning that the cURL site (https://curl.se/libcurl/c/CURLOPT_DNS_USE_GLOBAL_CACHE.html) includes: 'Has no function since 7.62.0. Do not use! '

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the CURLOPT_CONNECTTIMEOUT, CURLOPT_CONNECTTIMEOUT_MS, CURLOPT_DNS_CACHE_TIMEOUT, and CURLOPT_DNS_USE_GLOBAL_CACHE entries in the function.curl-setopt manual page. Compare them with the cited libcurl documentation, then update the default values and add the obsolete-option warning; done when the PHP descriptions match the referenced behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.