doc: MyFirstContribution: fix cmd placement instructions
PATCH 1/1 doc: MyFirstContribution: fix cmd placement instructions
Using the pull command instead of push is more accurate when giving instructions on placing the psuh command in alphabetical order.
--- Documentation/MyFirstContribution.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/MyFirstContribution.txt +4 -4
@@ -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: ----
Signature · 1 line
2.9.3
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
Quoted 51 lines · 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 <[email protected]>--- Documentation/MyFirstContribution.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/MyFirstContribution.txt +4
-4@@ -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: ----Signature · 1 line
2.9.3
Quoted 26 lines · Emily Shaffer
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
psuhimmediately after it" in these places instead. But I have no preference whatsoever.- Emily
Reviewed-by Emily Shaffer <[email protected]>Quoted 15 lines · 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 <[email protected]>--- Documentation/MyFirstContribution.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/MyFirstContribution.txt +0
-0@@ -97,7 +97,7 @@ int cmd_psuh(int argc, const char **argv, const char *prefix) ----
Quoted 3 lines
Documentation/MyFirstContribution.txt int cmd_psuh(int argc, const char **argv, const char *prefix) · line 100
Quoted 3 lines
Documentation/MyFirstContribution.txt +1
-1We'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
Quoted 33 lines
Quoted 33 lines
Documentation/MyFirstContribution.txt +3
-3in 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: ----Signature · 1 line
2.9.3
PATCH v2 1/1 doc: MyFirstContribution: fix cmd placement instructions
In reply to Pedro SousaUsing the pull command instead of push is more accurate when giving instructions on placing the psuh command in alphabetical order.
---
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(-)
Documentation/MyFirstContribution.txt +5 -5
@@ -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: ----
Signature · 1 line
2.9.3
Quoted 7 lines · 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 <[email protected]>---
Changes since v1: Addressed Philip's comments on making alphabetical sort instructions more explicit
LGTM. Thanks.
Philip
Quoted 46 lines
Documentation/MyFirstContribution.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)Documentation/MyFirstContribution.txt +5
-5@@ -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: ----