From: Emily Shaffer <emilyshaffer@google.com> To: git@vger.kernel.org Cc: Emily Shaffer <emilyshaffer@google.com>, Heba Waly <heba.waly@gmail.com> Subject: [PATCH v2 2/3] myfirstcontrib: add dependency installation step Date: Thu, 31 Oct 2019 14:03:37 -0700 [thread overview] Message-ID: <20191031210338.152529-3-emilyshaffer@google.com> (raw) In-Reply-To: <20191031210338.152529-1-emilyshaffer@google.com> 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> --- Documentation/MyFirstContribution.txt | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt index 12b7256454..5ce94e077c 100644 --- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.txt @@ -38,6 +38,26 @@ $ git clone https://github.com/git/git git $ cd git ---- +[[dependencies]] +=== Installing Dependencies + +To build Git from source, you need to have a handful of dependencies installed +on your system. For a hint of what's needed, you can take a look at +`INSTALL`, paying close attention to the section about Git's dependencies on +external programs and libraries. That document mentions a way to "test-drive" +our freshly built Git without installing; that's the method we'll be using in +this tutorial. + +Make sure that your environment has everything you need by building your brand +new clone of Git from the above step: + +---- +$ make +---- + +NOTE: The Git build is parallelizable. `-j#` is not included above but you can +use it as you prefer, here and elsewhere. + [[identify-problem]] === Identify Problem to Solve @@ -138,9 +158,6 @@ NOTE: When you are developing the Git project, it's preferred that you use the `DEVELOPER` flag; if there's some reason it doesn't work for you, you can turn it off, but it's a good idea to mention the problem to the mailing list. -NOTE: The Git build is parallelizable. `-j#` is not included above but you can -use it as you prefer, here and elsewhere. - Great, now your new command builds happily on its own. But nobody invokes it. Let's change that. -- 2.24.0.rc0.303.g954a862665-goog
next prev parent reply other threads:[~2019-10-31 21:04 UTC|newest] Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-10-26 0:51 [PATCH 0/3] some clarifications to MyFirstContribution Emily Shaffer 2019-10-26 0:51 ` [PATCH 1/3] myfirstcontrib: add 'psuh' to command-list.txt Emily Shaffer 2019-10-26 1:08 ` Jonathan Nieder 2019-10-26 8:00 ` SZEDER Gábor 2019-10-28 1:24 ` Junio C Hamano 2019-10-28 11:25 ` SZEDER Gábor 2019-10-29 20:39 ` Johannes Schindelin 2019-10-26 0:51 ` [PATCH 2/3] myfirstcontrib: add dependency installation step Emily Shaffer 2019-10-26 1:12 ` Jonathan Nieder 2019-10-28 1:27 ` Junio C Hamano 2019-10-31 20:58 ` Emily Shaffer 2019-10-26 0:51 ` [PATCH 3/3] myfirstcontrib: hint to find gitgitgadget allower Emily Shaffer 2019-10-26 1:15 ` Jonathan Nieder 2019-10-29 20:43 ` Johannes Schindelin 2019-10-27 1:39 ` Pratyush Yadav 2019-10-26 1:17 ` [PATCH 0/3] some clarifications to MyFirstContribution Jonathan Nieder 2019-10-31 21:03 ` [PATCH v2 " Emily Shaffer 2019-10-31 21:03 ` [PATCH v2 1/3] myfirstcontrib: add 'psuh' to command-list.txt Emily Shaffer 2019-10-31 21:03 ` Emily Shaffer [this message] 2019-10-31 21:03 ` [PATCH v2 3/3] myfirstcontrib: hint to find gitgitgadget allower Emily Shaffer
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 * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20191031210338.152529-3-emilyshaffer@google.com \ --to=emilyshaffer@google.com \ --cc=git@vger.kernel.org \ --cc=heba.waly@gmail.com \ --subject='Re: [PATCH v2 2/3] myfirstcontrib: add dependency installation step' \ /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
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).