git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/3] myfirstcontrib: add dependency installation step

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 28, 2019, 01:27 UTC
Message-ID
<xmqqimo9bqwy.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<20191026011250.GB39574@google.com>
Jonathan Nieder <jrnieder@gmail.com> writes:
Show 31 quoted lines
> 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)

This section, as you hinted at the beginning, should be a single sentence, i.e. just "follow INSTALL". Any clarifications should be made as a patch to the INSTALL file.

Thanks.
Previous: Jonathan NiederNext: Emily Shaffer
Message 10 of 20 in “some clarifications to MyFirstContribution”
  1. 0/3 some clarifications to MyFirstContributionEmily Shaffer, Oct 26, 2019
  2. 1/3 myfirstcontrib: add 'psuh' to command-list.txtEmily Shaffer, Oct 26, 2019
  3. Jonathan NiederOct 26, 2019
  4. SZEDER GáborOct 26, 2019
  5. Junio C HamanoOct 28, 2019
  6. SZEDER GáborOct 28, 2019
  7. Johannes SchindelinOct 29, 2019
  8. 2/3 myfirstcontrib: add dependency installation stepEmily Shaffer, Oct 26, 2019
  9. Jonathan NiederOct 26, 2019
  10. Junio C HamanoOct 28, 2019
  11. Emily ShafferOct 31, 2019
  12. 3/3 myfirstcontrib: hint to find gitgitgadget allowerEmily Shaffer, Oct 26, 2019
  13. Jonathan NiederOct 26, 2019
  14. Johannes SchindelinOct 29, 2019
  15. Pratyush YadavOct 27, 2019
  16. Jonathan NiederOct 26, 2019
  17. 0/3 some clarifications to MyFirstContributionEmily Shaffer, Oct 31, 2019
  18. 1/3 myfirstcontrib: add 'psuh' to command-list.txtEmily Shaffer, Oct 31, 2019
  19. 2/3 myfirstcontrib: add dependency installation stepEmily Shaffer, Oct 31, 2019
  20. 3/3 myfirstcontrib: hint to find gitgitgadget allowerEmily Shaffer, Oct 31, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.