Re: [PATCH 2/3] myfirstcontrib: add dependency installation step
From: Jonathan Nieder <hidden>
Date: 2019-10-26 01:12:55
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. [...]
quoted hunk ↗ jump to hunk
--- 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.
quoted hunk ↗ jump to hunk
+---- + +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 <redacted> Thanks.