git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Philip Oakley <philipoakley@iee.email>
To: Emily Shaffer <emilyshaffer@google.com>,
	Pedro Sousa <pedroteosousa@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Jonathan Tan <jonathantanmy@google.com>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH] doc: MyFirstContribution: fix cmd placement instructions
Date: Fri, 20 Sep 2019 10:42:40 +0100	[thread overview]
Message-ID: <bba245d1-2828-e356-6f78-6a0bb47cc7e1@iee.email> (raw)
In-Reply-To: <20190919204627.GB116396@google.com>

On 19/09/2019 21:46, Emily Shaffer wrote:
> Thanks for sending this. I guess I don't know the alphabet very well :)
>
> A different color we could paint the bikeshed would be to write "add a
> new line for `psuh` immediately after it" in these places instead. But I
> have no preference whatsoever.
>
>   - Emily
>
> Reviewed-by: Emily Shaffer <emilyshaffer@google.com>
>
> On Thu, Sep 19, 2019 at 03:46:34PM -0300, Pedro Sousa wrote:
>> Using the pull command instead of push is more accurate when giving
>> instructions on placing the psuh command in alphabetical order.
>>
>> Signed-off-by: Pedro Sousa <pedroteosousa@gmail.com>
>> ---
>>   Documentation/MyFirstContribution.txt | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
>> index f867037..fb15af8 100644
>> --- a/Documentation/MyFirstContribution.txt
>> +++ b/Documentation/MyFirstContribution.txt
>> @@ -97,7 +97,7 @@ int cmd_psuh(int argc, const char **argv, const char *prefix)
>>   ----
>>   
>>   We'll also need to add the declaration of psuh; open up `builtin.h`, find the
>> -declaration for `cmd_push`, and add a new line for `psuh` immediately before it,
>> +declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
Maybe feature the "alphabetical" sort order (i.e. include the word 
here), so that other see it (use of alphabetical sorting) that little 
more obviously in the tutorial material.
Philip
>>   in order to keep the declarations sorted:
>>   
>>   ----
>> @@ -123,7 +123,7 @@ int cmd_psuh(int argc, const char **argv, const char *prefix)
>>   }
>>   ----
>>   
>> -Let's try to build it.  Open `Makefile`, find where `builtin/push.o` is added
>> +Let's try to build it.  Open `Makefile`, find where `builtin/pull.o` is added
>>   to `BUILTIN_OBJS`, and add `builtin/psuh.o` in the same way next to it in
>>   alphabetical order. Once you've done so, move to the top-level directory and
>>   build simply with `make`. Also add the `DEVELOPER=1` variable to turn on
>> @@ -149,7 +149,7 @@ a `cmd_struct` to the `commands[]` array. `struct cmd_struct` takes a string
>>   with the command name, a function pointer to the command implementation, and a
>>   setup option flag. For now, let's keep mimicking `push`. Find the line where
>>   `cmd_push` is registered, copy it, and modify it for `cmd_psuh`, placing the new
>> -line in alphabetical order.
>> +line in alphabetical order (immediately before `cmd_pull`).
>>   
>>   The options are documented in `builtin.h` under "Adding a new built-in." Since
>>   we hope to print some data about the user's current workspace context later,
>> @@ -167,7 +167,7 @@ Check it out! You've got a command! Nice work! Let's commit this.
>>   
>>   `git status` reveals modified `Makefile`, `builtin.h`, and `git.c` as well as
>>   untracked `builtin/psuh.c` and `git-psuh`. First, let's take care of the binary,
>> -which should be ignored. Open `.gitignore` in your editor, find `/git-push`, and
>> +which should be ignored. Open `.gitignore` in your editor, find `/git-pull`, and
>>   add an entry for your new command in alphabetical order:
>>   
>>   ----
>> -- 
>> 2.9.3
>>


  reply	other threads:[~2019-09-20  9:42 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-19 18:46 [PATCH] doc: MyFirstContribution: fix cmd placement instructions Pedro Sousa
2019-09-19 20:46 ` Emily Shaffer
2019-09-20  9:42   ` Philip Oakley [this message]
2019-09-26 19:05 ` [PATCH v2] " Pedro Sousa
2019-09-26 21:42   ` Philip Oakley

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=bba245d1-2828-e356-6f78-6a0bb47cc7e1@iee.email \
    --to=philipoakley@iee.email \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jonathantanmy@google.com \
    --cc=pedroteosousa@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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).