myfirstcontrib: add dependency installation step
Indicate that the user needs some dependencies before the build will run happily on their machine; this dependency list doesn't seem to be made clear anywhere else in the project documentation. Then, so the user can be certain any build failures are due to their code and not their environment, perform a build on a clean checkout of 'master'. Also, move the note about build parallelization up here, so that it appears next to the very first build invocation in the tutorial. Reported-by: Heba Waly <heba.waly@gmail.com> Signed-off-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Emily Shaffer committed
Oct 31, 2019 at 14:03 UTC
3ada78de3f8dbe2b0a2b67cade25d29a86f734c3
1 file changed
+20
-3
Documentation/MyFirstContribution.txt
+20
-3
@@ -38,6 +38,26 @@ $ git clone https://github.com/git/git git
38
$ cd git
39
----
40
41
+[[dependencies]]
42
+=== Installing Dependencies
43
+
44
+To build Git from source, you need to have a handful of dependencies installed
45
+on your system. For a hint of what's needed, you can take a look at
46
+`INSTALL`, paying close attention to the section about Git's dependencies on
47
+external programs and libraries. That document mentions a way to "test-drive"
48
+our freshly built Git without installing; that's the method we'll be using in
49
+this tutorial.
50
+
51
+Make sure that your environment has everything you need by building your brand
52
+new clone of Git from the above step:
53
+
54
+----
55
+$ make
56
+----
57
+
58
+NOTE: The Git build is parallelizable. `-j#` is not included above but you can
59
+use it as you prefer, here and elsewhere.
60
+
61
[[identify-problem]]
62
=== Identify Problem to Solve
63
@@ -138,9 +158,6 @@ NOTE: When you are developing the Git project, it's preferred that you use the
158
`DEVELOPER` flag; if there's some reason it doesn't work for you, you can turn
159
it off, but it's a good idea to mention the problem to the mailing list.
160
141
-NOTE: The Git build is parallelizable. `-j#` is not included above but you can
142
-use it as you prefer, here and elsewhere.
143
-
161
Great, now your new command builds happily on its own. But nobody invokes it.
162
Let's change that.
163