git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] doc: clarify server behavior for invalid 'want' lines in HTTP protocol
@ 2025-11-04 10:06 Queen Ediri Jessa
  2025-11-04 14:35 ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Queen Ediri Jessa @ 2025-11-04 10:06 UTC (permalink / raw)
  To: git; +Cc: christian.couder, usman.akinyemi, QueenJcloud

From: QueenJcloud <qjessa662@gmail.com>


From: Queen Ediri Jessa <qjessa662@gmail.com>


Update the documentation to clearly describe how the server responds when a
client sends an invalid or malformed `want` line during the HTTP protocol
exchange. This improves understanding of Git’s behavior when handling
incorrect object requests and helps developers detect and handle such
protocol issues accurately.

Signed-off-by: Queen Ediri Jessa <qjessa662@gmail.com>

Changes since v1:
- Rephrased the explanation to be more concise and aligned with reviewer
  feedback.
- Clarified that the server includes the offending object name in its error
  message.
- Adjusted tone to describe the expected behavior rather than prescribing
  implementation-specific messages.
- Improved readability and technical consistency of the section.
---
 Documentation/gitprotocol-http.adoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/gitprotocol-http.adoc b/Documentation/gitprotocol-http.adoc
index d024010414..f3f48d3f35 100644
--- a/Documentation/gitprotocol-http.adoc
+++ b/Documentation/gitprotocol-http.adoc
@@ -443,7 +443,10 @@ If no "want" objects are received, send an error:
 TODO: Define error if no "want" lines are requested.
 
 If any "want" object is not reachable, send an error:
-TODO: Define error if an invalid "want" is requested.
+When a Git server receives an invalid or malformed `want` line, it
+responds with an error message that includes the offending object name.
+This clarifies the expected behavior for Git implementations and helps
+clients detect protocol issues accurately during fetch operations.
 
 Create an empty list, `s_common`.
 
-- 
2.51.0.573.gb660e2dcb9


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] doc: clarify server behavior for invalid 'want' lines in HTTP protocol
  2025-11-04 10:06 [PATCH v2] doc: clarify server behavior for invalid 'want' lines in HTTP protocol Queen Ediri Jessa
@ 2025-11-04 14:35 ` Junio C Hamano
  2025-11-04 15:17   ` Queen Ediri Jessa
  0 siblings, 1 reply; 3+ messages in thread
From: Junio C Hamano @ 2025-11-04 14:35 UTC (permalink / raw)
  To: Queen Ediri Jessa; +Cc: git, christian.couder, usman.akinyemi

Queen Ediri Jessa <qjessa662@gmail.com> writes:

> From: QueenJcloud <qjessa662@gmail.com>
>
>
> From: Queen Ediri Jessa <qjessa662@gmail.com>
>
>
> Update the documentation to clearly describe how the server responds when a
> client sends an invalid or malformed `want` line during the HTTP protocol
> exchange. This improves understanding of Git’s behavior when handling
> incorrect object requests and helps developers detect and handle such
> protocol issues accurately.
>
> Signed-off-by: Queen Ediri Jessa <qjessa662@gmail.com>
>
> Changes since v1:
> - Rephrased the explanation to be more concise and aligned with reviewer
>   feedback.
> - Clarified that the server includes the offending object name in its error
>   message.
> - Adjusted tone to describe the expected behavior rather than prescribing
>   implementation-specific messages.
> - Improved readability and technical consistency of the section.
> ---
>  Documentation/gitprotocol-http.adoc | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)

I'll locally fix up before queuing this time, but

 * You now have one in-body header to force "From: QueenJcloud",
   after which the blank line declares everything below is the body
   and no in-body header remains, and then you have another line
   "From: Queen Ediri Jessa" that is not an in-body header.  Perhaps
   you should send your e-mail only to yourself without sending to
   the list as practice to prevent them from appearing again?  You
   only want the second one, IIUC.

 * Describing "Changes since..." is a very good idea, but that
   should be done _after_ the three-dash line, not beffore.

Thanks.

> diff --git a/Documentation/gitprotocol-http.adoc b/Documentation/gitprotocol-http.adoc
> index d024010414..f3f48d3f35 100644
> --- a/Documentation/gitprotocol-http.adoc
> +++ b/Documentation/gitprotocol-http.adoc
> @@ -443,7 +443,10 @@ If no "want" objects are received, send an error:
>  TODO: Define error if no "want" lines are requested.
>  
>  If any "want" object is not reachable, send an error:
> -TODO: Define error if an invalid "want" is requested.
> +When a Git server receives an invalid or malformed `want` line, it
> +responds with an error message that includes the offending object name.
> +This clarifies the expected behavior for Git implementations and helps
> +clients detect protocol issues accurately during fetch operations.
>  
>  Create an empty list, `s_common`.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] doc: clarify server behavior for invalid 'want' lines in HTTP protocol
  2025-11-04 14:35 ` Junio C Hamano
@ 2025-11-04 15:17   ` Queen Ediri Jessa
  0 siblings, 0 replies; 3+ messages in thread
From: Queen Ediri Jessa @ 2025-11-04 15:17 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, christian.couder, usman.akinyemi

Thanks for the feedback, Junio.
I’ll fix the duplicate “From” line and move the “Changes since”
section below the --- line as suggested.
I’ll resend this as v3 after testing locally.

On Tue, Nov 4, 2025 at 3:35 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> Queen Ediri Jessa <qjessa662@gmail.com> writes:
>
> > From: QueenJcloud <qjessa662@gmail.com>
> >
> >
> > From: Queen Ediri Jessa <qjessa662@gmail.com>
> >
> >
> > Update the documentation to clearly describe how the server responds when a
> > client sends an invalid or malformed `want` line during the HTTP protocol
> > exchange. This improves understanding of Git’s behavior when handling
> > incorrect object requests and helps developers detect and handle such
> > protocol issues accurately.
> >
> > Signed-off-by: Queen Ediri Jessa <qjessa662@gmail.com>
> >
> > Changes since v1:
> > - Rephrased the explanation to be more concise and aligned with reviewer
> >   feedback.
> > - Clarified that the server includes the offending object name in its error
> >   message.
> > - Adjusted tone to describe the expected behavior rather than prescribing
> >   implementation-specific messages.
> > - Improved readability and technical consistency of the section.
> > ---
> >  Documentation/gitprotocol-http.adoc | 5 ++++-
> >  1 file changed, 4 insertions(+), 1 deletion(-)
>
> I'll locally fix up before queuing this time, but
>
>  * You now have one in-body header to force "From: QueenJcloud",
>    after which the blank line declares everything below is the body
>    and no in-body header remains, and then you have another line
>    "From: Queen Ediri Jessa" that is not an in-body header.  Perhaps
>    you should send your e-mail only to yourself without sending to
>    the list as practice to prevent them from appearing again?  You
>    only want the second one, IIUC.
>
>  * Describing "Changes since..." is a very good idea, but that
>    should be done _after_ the three-dash line, not beffore.
>
> Thanks.
>
> > diff --git a/Documentation/gitprotocol-http.adoc b/Documentation/gitprotocol-http.adoc
> > index d024010414..f3f48d3f35 100644
> > --- a/Documentation/gitprotocol-http.adoc
> > +++ b/Documentation/gitprotocol-http.adoc
> > @@ -443,7 +443,10 @@ If no "want" objects are received, send an error:
> >  TODO: Define error if no "want" lines are requested.
> >
> >  If any "want" object is not reachable, send an error:
> > -TODO: Define error if an invalid "want" is requested.
> > +When a Git server receives an invalid or malformed `want` line, it
> > +responds with an error message that includes the offending object name.
> > +This clarifies the expected behavior for Git implementations and helps
> > +clients detect protocol issues accurately during fetch operations.
> >
> >  Create an empty list, `s_common`.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-11-04 15:17 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-04 10:06 [PATCH v2] doc: clarify server behavior for invalid 'want' lines in HTTP protocol Queen Ediri Jessa
2025-11-04 14:35 ` Junio C Hamano
2025-11-04 15:17   ` Queen Ediri Jessa

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).