| Message ID | pull.1733.git.git.1719177846725.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | doc: update http.cookieFile with in-memory cookie processing | expand |
On 23.06.2024 23:24, Piotr Szlazak via GitGitGadget wrote: > From: Piotr Szlazak <piotr.szlazak@gmail.com> > > Information added how to enable in-memory cookies > processing. Cookies from server will be accepted and send > back in successive requests within same connection. > > At the moment documentation only mentions how to read > cookies from the given file and how to save them to the file > using http.saveCookies. > > curl / libcurl will process cookies in memory if file name > is blank. Check curl manpage: > https://curl.se/docs/manpage.html#-b > This is described here in more details: > https://everything.curl.dev/http/cookies/engine.html > And also explained here: > https://www.youtube.com/watch?v=V5vZWHP-RqU&t=11459s > > Git documentation was updated to include suggestion how to > enable this by setting empty value for http.cookieFile. > > Signed-off-by: Piotr Szlazak <piotr.szlazak@gmail.com> Hello Junio! Would you be able to take a look at my commit? It's a small update in Documentation/config/http.txt, where I wanted to share how to enable in-memory HTTP cookies processing. It's more curl/libcurl related thing, but worth to be known by Git users. Regards! -- Piotr Szlazak > --- > Update http.cookieFile with in-memory cookie processing Published-As: > https://github.com/gitgitgadget/git/releases/tag/pr-git-1733%2Fpszlazak%2Fdocumentation-cookieFile-in-memory-v1Fetch-It-Via: > git fetch https://github.com/gitgitgadget/git > pr-git-1733/pszlazak/documentation-cookieFile-in-memory-v1 > Pull-Request: https://github.com/git/git/pull/1733 > Documentation/config/http.txt | 8 ++++---- 1 file changed, 4 > insertions(+), 4 deletions(-) diff --git > a/Documentation/config/http.txt b/Documentation/config/http.txt index > 2d4e0c9b869..228bed32ec1 100644 --- a/Documentation/config/http.txt > +++ b/Documentation/config/http.txt @@ -78,10 +78,10 @@ > http.extraHeader:: http.cookieFile:: The pathname of a file containing > previously stored cookie lines, - which should be used - in the Git > http session, if they match the server. The file format - of the file > to read cookies from should be plain HTTP headers or - the > Netscape/Mozilla cookie file format (see `curl(1)`). + which should be > used in the Git http session, if they match the server. + The file > format of the file to read cookies from should be plain HTTP + headers > or the Netscape/Mozilla cookie file format (see `curl(1)`). + Set it > to empty value, to enable in-memory cookies processing. NOTE that the > file specified with http.cookieFile is used only as input unless > http.saveCookies is set. base-commit: > 66ac6e4bcd111be3fa9c2a6b3fafea718d00678d
Piotr Szlazak <piotr.szlazak@gmail.com> writes: > Hello Junio! > Would you be able to take a look at my commit? Please do not specifically name me. If I did not respond, that was because I considered it was outside my area of expertise, so pinging me would not help all that much. CC'ed folks who touched http.c (where the configuration is used) in the past 6 months to ask for their help. Thanks.
"Piotr Szlazak via GitGitGadget" <gitgitgadget@gmail.com> writes: > http.cookieFile:: > The pathname of a file containing previously stored cookie lines, > - which should be used > - in the Git http session, if they match the server. The file format > - of the file to read cookies from should be plain HTTP headers or > - the Netscape/Mozilla cookie file format (see `curl(1)`). > + which should be used in the Git http session, if they match the server. > + The file format of the file to read cookies from should be plain HTTP > + headers or the Netscape/Mozilla cookie file format (see `curl(1)`). With line wrapping it is hard to see if there is any change above here, but I assume there is none? > + Set it to empty value, to enable in-memory cookies processing. Is it understandable what "in-memory cookies processing" means to expected audience of this manual page? I somehow doubt it (I certainly do not know what you wanted it to mean). https://curl.se/libcurl/c/CURLOPT_COOKIEFILE.html has this to say: By passing the empty string ("") to this option, you enable the cookie engine without reading any initial cookies. But http.cookiefile is also used for CURLOPT_COOKIEJAR when http.savecookies is true. Its documentation page does not say what would happen if you give an empty string to it. So, a casual one-line mention you added is a bit irresponsible. At least you should warn against setting http.savecookies if the user chooses to use "" for this, or better yet, fix the codepath to use http.savecookies to prevent us from writing to a file with an empty filename. Also the libcURL documentation for CURLOPT_COOKIEFILE has another thing that is a bit worrysome: If you tell libcurl the filename is "-" (just a single minus sign), libcurl instead reads from stdin. So you can easily get your git get stuck by doing git -c http.cookiefile=- fetch https://..... as libcURL will want to read from your stdin, while you are waiting for the fetch to finish and are not typing anything?
On 10.07.2024 01:05, Junio C Hamano wrote: > "Piotr Szlazak via GitGitGadget" <gitgitgadget@gmail.com> writes: > >> http.cookieFile:: >> The pathname of a file containing previously stored cookie lines, >> - which should be used >> - in the Git http session, if they match the server. The file format >> - of the file to read cookies from should be plain HTTP headers or >> - the Netscape/Mozilla cookie file format (see `curl(1)`). >> + which should be used in the Git http session, if they match the server. >> + The file format of the file to read cookies from should be plain HTTP >> + headers or the Netscape/Mozilla cookie file format (see `curl(1)`). > With line wrapping it is hard to see if there is any change above > here, but I assume there is none? Sorry for bad formatting, I'm still learning. > >> + Set it to empty value, to enable in-memory cookies processing. > Is it understandable what "in-memory cookies processing" means to > expected audience of this manual page? I somehow doubt it (I > certainly do not know what you wanted it to mean). I pushed PATCH 2, this time without curl/libcurl terminology (i.e. without calling it in-memory cookie processing). Hope it helps. I also mentioned there that http.saveCookies has no effect if '' was used for http.cookieFile. Regards!
diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt index 2d4e0c9b869..228bed32ec1 100644 --- a/Documentation/config/http.txt +++ b/Documentation/config/http.txt @@ -78,10 +78,10 @@ http.extraHeader:: http.cookieFile:: The pathname of a file containing previously stored cookie lines, - which should be used - in the Git http session, if they match the server. The file format - of the file to read cookies from should be plain HTTP headers or - the Netscape/Mozilla cookie file format (see `curl(1)`). + which should be used in the Git http session, if they match the server. + The file format of the file to read cookies from should be plain HTTP + headers or the Netscape/Mozilla cookie file format (see `curl(1)`). + Set it to empty value, to enable in-memory cookies processing. NOTE that the file specified with http.cookieFile is used only as input unless http.saveCookies is set.