From: Jonathan Nieder <jrnieder@gmail.com>
To: Emily Shaffer <emilyshaffer@google.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/3] myfirstcontrib: add dependency installation step
Date: Fri, 25 Oct 2019 18:12:51 -0700 [thread overview]
Message-ID: <20191026011250.GB39574@google.com> (raw)
In-Reply-To: <20191026005159.98405-3-emilyshaffer@google.com>
Hi,
Emily Shaffer wrote:
> 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.
In theory, this info should be in INSTALL. I wouldn't be surprised if
it's missing some info, though.
[...]
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -38,6 +38,30 @@ $ 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
> +`ci/install-dependencies.sh`.
> +
> +To install the dependencies needed for a basic build on Linux, run something
> +like this (or replace `apt` with your distribution's package manager of choice):
pedantic nit: s/or replace/replacing/ ("or" would mean rpm is an
alternative to what came before, but "something like" in the phrase
before has rpm already included)
> +
> +----
> +# apt install libssl-dev zlib1g-dev libcurl4-gnutls-dev libexpat1-dev
Perhaps build-essential, too, in case they're using a system not set up
for development.
> +----
> +
> +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 +162,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.
With whatever subset of the changes above make sense,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Thanks.
next prev parent reply other threads:[~2019-10-26 1:12 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 [this message]
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 ` [PATCH v2 2/3] myfirstcontrib: add dependency installation step Emily Shaffer
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=20191026011250.GB39574@google.com \
--to=jrnieder@gmail.com \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).