git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "John Cai via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, John Cai <johncai86@gmail.com>,
	Emily Shaffer <emilyshaffer@google.com>
Subject: Re: [PATCH 2/2] docs: add headers in MyFirstObjectWalk
Date: Wed, 27 Oct 2021 14:17:31 -0700	[thread overview]
Message-ID: <xmqqk0hyupzo.fsf@gitster.g> (raw)
In-Reply-To: <33cd9b2e8a675bf79132d312da8b7d8f4a2b84a3.1635343531.git.gitgitgadget@gmail.com> (John Cai via GitGitGadget's message of "Wed, 27 Oct 2021 14:05:31 +0000")

"John Cai via GitGitGadget" <gitgitgadget@gmail.com> writes:

>  Add usage text and `-h` handling, like all subcommands should consistently do
> -(our test suite will notice and complain if you fail to do so).
> +(our test suite will notice and complain if you fail to do so). We'll need to include
> +the "parse-options.h" header.

OK, but wrap this overlong line.  All the lines updated by this
patch, except the one in the last hunk, have become overly long.

[jc: cc'ed the primary author of the document to sanity checking]

Thanks.

>  
>  ----
> +#include "parse-options.h"
> +
> +...
> +
>  int cmd_walken(int argc, const char **argv, const char *prefix)
>  {
>  	const char * const walken_usage[] = {
> @@ -195,9 +200,13 @@ Similarly to the default values, we don't have anything to do here yet
>  ourselves; however, we should call `git_default_config()` if we aren't calling
>  any other existing config callbacks.
>  
> -Add a new function to `builtin/walken.c`:
> +Add a new function to `builtin/walken.c`. We'll also need to include the "config.h" header:
>  
>  ----
> +#include "config.h"
> +
> +...
> +
>  static int git_walken_config(const char *var, const char *value, void *cb)
>  {
>  	/*
> @@ -229,8 +238,14 @@ typically done by calling `repo_init_revisions()` with the repository you intend
>  to target, as well as the `prefix` argument of `cmd_walken` and your `rev_info`
>  struct.
>  
> -Add the `struct rev_info` and the `repo_init_revisions()` call:
> +Add the `struct rev_info` and the `repo_init_revisions()` call. We'll also need to include
> +the "revision.h" header:
> +
>  ----
> +#include "revision.h"
> +
> +...
> +
>  int cmd_walken(int argc, const char **argv, const char *prefix)
>  {
>  	/* This can go wherever you like in your declarations.*/
> @@ -624,9 +639,14 @@ static void walken_object_walk(struct rev_info *rev)
>  ----
>  
>  Let's start by calling just the unfiltered walk and reporting our counts.
> -Complete your implementation of `walken_object_walk()`:
> +Complete your implementation of `walken_object_walk()`. We'll also need to
> +include the "list-objects.h" header.
>  
>  ----
> +#include "list-objects.h"
> +
> +...
> +
>  	traverse_commit_list(rev, walken_show_commit, walken_show_object, NULL);
>  
>  	printf("commits %d\nblobs %d\ntags %d\ntrees %d\n", commit_count,

  parent reply	other threads:[~2021-10-27 21:17 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-27 14:05 [PATCH 0/2] fix up example code in MyFirstObjectWalk tutorial John Cai via GitGitGadget
2021-10-27 14:05 ` [PATCH 1/2] docs: fix places that break compliation in MyFirstObjectWalk John Cai via GitGitGadget
2021-10-27 17:05   ` Eric Sunshine
2021-10-27 14:05 ` [PATCH 2/2] docs: add headers " John Cai via GitGitGadget
2021-10-27 17:09   ` Eric Sunshine
2021-10-27 21:17   ` Junio C Hamano [this message]
2021-10-30  7:33   ` Bagas Sanjaya
2021-10-30  7:49     ` Eric Sunshine
2021-10-29 17:58 ` [PATCH v2 0/2] fix up example code in MyFirstObjectWalk tutorial John Cai via GitGitGadget
2021-10-29 17:58   ` [PATCH v2 1/2] docs: fix places that break compilation in MyFirstObjectWalk John Cai via GitGitGadget
2021-10-29 18:04     ` Eric Sunshine
2021-10-29 17:58   ` [PATCH v2 2/2] docs: add headers " John Cai via GitGitGadget
2021-10-29 19:52   ` [PATCH v3 0/2] fix up example code in MyFirstObjectWalk tutorial John Cai via GitGitGadget
2021-10-29 19:52     ` [PATCH v3 1/2] docs: fix places that break compilation in MyFirstObjectWalk John Cai via GitGitGadget
2021-10-29 19:52     ` [PATCH v3 2/2] docs: add headers " John Cai via GitGitGadget
2021-10-29 21:28     ` [PATCH v3 0/2] fix up example code in MyFirstObjectWalk tutorial Eric Sunshine

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=xmqqk0hyupzo.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=johncai86@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;
as well as URLs for NNTP newsgroup(s).