doc: MyFirstContribution: fix cmd placement instructions
diff mbox series

Message ID 20190919184634.8869-1-pedroteosousa@gmail.com
State New
Headers show
Series
  • doc: MyFirstContribution: fix cmd placement instructions
Related show

Commit Message

Pedro Sousa Sept. 19, 2019, 6:46 p.m. UTC
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(-)

Comments

Emily Shaffer Sept. 19, 2019, 8:46 p.m. UTC | #1
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
>
Philip Oakley Sept. 20, 2019, 9:42 a.m. UTC | #2
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
>>

Patch
diff mbox series

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:
 
 ----