* [PATCH] doc: MyFirstContribution: fix cmd placement instructions
@ 2019-09-19 18:46 Pedro Sousa
2019-09-19 20:46 ` Emily Shaffer
2019-09-26 19:05 ` [PATCH v2] " Pedro Sousa
0 siblings, 2 replies; 5+ messages in thread
From: Pedro Sousa @ 2019-09-19 18:46 UTC (permalink / raw)
To: git
Cc: Pedro Sousa, Junio C Hamano, Jonathan Tan, Johannes Schindelin,
Emily Shaffer
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,
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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: MyFirstContribution: fix cmd placement instructions
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
2019-09-26 19:05 ` [PATCH v2] " Pedro Sousa
1 sibling, 1 reply; 5+ messages in thread
From: Emily Shaffer @ 2019-09-19 20:46 UTC (permalink / raw)
To: Pedro Sousa; +Cc: git, Junio C Hamano, Jonathan Tan, Johannes Schindelin
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,
> 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
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: MyFirstContribution: fix cmd placement instructions
2019-09-19 20:46 ` Emily Shaffer
@ 2019-09-20 9:42 ` Philip Oakley
0 siblings, 0 replies; 5+ messages in thread
From: Philip Oakley @ 2019-09-20 9:42 UTC (permalink / raw)
To: Emily Shaffer, Pedro Sousa
Cc: git, Junio C Hamano, Jonathan Tan, Johannes Schindelin
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
>>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] doc: MyFirstContribution: fix cmd placement instructions
2019-09-19 18:46 [PATCH] doc: MyFirstContribution: fix cmd placement instructions Pedro Sousa
2019-09-19 20:46 ` Emily Shaffer
@ 2019-09-26 19:05 ` Pedro Sousa
2019-09-26 21:42 ` Philip Oakley
1 sibling, 1 reply; 5+ messages in thread
From: Pedro Sousa @ 2019-09-26 19:05 UTC (permalink / raw)
To: git
Cc: Johannes.Schindelin, emilyshaffer, gitster, jonathantanmy,
philipoakley, Pedro Sousa
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>
---
Changes since v1: Addressed Philip's comments on making alphabetical
sort instructions more explicit
Documentation/MyFirstContribution.txt | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index f867037..5e9b808 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -97,8 +97,8 @@ 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,
-in order to keep the declarations sorted:
+declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
+in order to keep the declarations alphabetically sorted:
----
int cmd_psuh(int argc, const char **argv, const char *prefix);
@@ -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
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] doc: MyFirstContribution: fix cmd placement instructions
2019-09-26 19:05 ` [PATCH v2] " Pedro Sousa
@ 2019-09-26 21:42 ` Philip Oakley
0 siblings, 0 replies; 5+ messages in thread
From: Philip Oakley @ 2019-09-26 21:42 UTC (permalink / raw)
To: Pedro Sousa, git
Cc: Johannes.Schindelin, emilyshaffer, gitster, jonathantanmy
On 26/09/2019 20:05, 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>
> ---
> Changes since v1: Addressed Philip's comments on making alphabetical
> sort instructions more explicit
LGTM. Thanks.
Philip
>
> Documentation/MyFirstContribution.txt | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
> index f867037..5e9b808 100644
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -97,8 +97,8 @@ 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,
> -in order to keep the declarations sorted:
> +declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
> +in order to keep the declarations alphabetically sorted:
>
> ----
> int cmd_psuh(int argc, const char **argv, const char *prefix);
> @@ -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:
>
> ----
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2019-09-26 21:42 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2019-09-26 19:05 ` [PATCH v2] " Pedro Sousa
2019-09-26 21:42 ` Philip Oakley
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).