public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Vinayak Dev <vinayakdev.sci@gmail.com>
Cc: Elijah Newren <newren@gmail.com>,
	nasamuffin@google.com, git@vger.kernel.org
Subject: Re: [PATCH] docs: include "trace.h" in MyFirstObjectWalk.txt
Date: Fri, 30 Jun 2023 09:25:07 -0700	[thread overview]
Message-ID: <xmqqsfa87w9o.fsf@gitster.g> (raw)
In-Reply-To: <CADE8NapyQJU1rDPvyMcRXcJfz3kzzg_fYXSSEvYJ7dFO+UHGaQ@mail.gmail.com> (Vinayak Dev's message of "Fri, 30 Jun 2023 11:39:08 +0530")

Vinayak Dev <vinayakdev.sci@gmail.com> writes:

> That is a good suggestion, but wouldn't the same argument apply to
> including trace.h itself? It makes it necessary for the code to work
> that any API changes must involve changing the included headers.

Exactly.  That is exactly what I meant by "tone down 'defined in X'
somehow to hint that these details may change".  

IOW, it may allow us to "cop out" of the problem to say "You'd add a
new file like so, and call this API function, and include headers
necessary to do so.  The codebase may have evolved since this
tutorial was written, so some details (like names of the API
functions and in which header files the functions are declared) may
be different in the code you have."

> Either way, I would be happy to fix my mistake. Should I send out a V2?

Oh, sorry to see you took it that way.  I think the change you sent
as-is is a fine fix for the immediate problem.  Everything you
quoted above is "while the issue is fresh on our minds, what are the
follow-up improvements we can make" material, so there is no "mistake"
to fix.

  reply	other threads:[~2023-06-30 16:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-29 18:52 [PATCH] docs: include "trace.h" in MyFirstObjectWalk.txt Vinayak Dev
2023-06-29 21:13 ` Junio C Hamano
2023-06-30  6:09   ` Vinayak Dev
2023-06-30 16:25     ` Junio C Hamano [this message]
2023-06-30 16:50       ` Vinayak Dev

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqsfa87w9o.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=nasamuffin@google.com \
    --cc=newren@gmail.com \
    --cc=vinayakdev.sci@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox