Page MenuHomeFreeBSD

Document GH_SUBDIR.
ClosedPublic

Authored by mat on Aug 26 2016, 11:10 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Apr 14, 12:31 PM
Unknown Object (File)
Jan 21 2024, 10:54 PM
Unknown Object (File)
Jan 1 2024, 2:27 AM
Unknown Object (File)
Jan 1 2024, 2:24 AM
Unknown Object (File)
Dec 20 2023, 12:30 AM
Unknown Object (File)
Nov 11 2023, 6:35 PM
Unknown Object (File)
Nov 11 2023, 1:41 PM
Unknown Object (File)
Nov 8 2023, 2:16 AM
Subscribers
None

Details

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

mat retitled this revision from to Document GH_SUBDIR..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added a reviewer: wblock.
  • Add an example on how to do work with git submodules.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
1997 ↗(On Diff #19722)

Remove "all"

2001 ↗(On Diff #19722)

s/one/a single/

2184 ↗(On Diff #19722)

"What it basically does" is not needed. Better to just name it and use the present tense. Also, the subdirectory name should be in <filename> tags when being referred to as a directory (rather than a value to be set).

<varname>GH_SUBDIR</varname> makes sure that
<filename>ext</filename> exists, but that
<filename>ext/icons</filename> does not already exist.  Then it
does this:</para>
2221 ↗(On Diff #19722)

Seems like this could be simpler:

Ports with GitHub as an upstream repository sometimes use submodules.
2223 ↗(On Diff #19722)

Can probably end the sentence after "information".

2227 ↗(On Diff #19722)

s/need to be/must be/

2232 ↗(On Diff #19722)

Extra space between "example," and "its".

2236 ↗(On Diff #19722)
file at the root.  This file describes all the submodules used in this repository, and lists additional repositories needed.
2285 ↗(On Diff #19722)

Break sentence here. s/, each/. Each/

2286 ↗(On Diff #19722)

"in fact" is not needed.

2294 ↗(On Diff #19722)
<command>git submodule status</command> will provide more
2295 ↗(On Diff #19722)

Break sentence here:

meaningful information.  For example, here,
2300 ↗(On Diff #19722)

Why?

2303 ↗(On Diff #19722)

s/have/has/ (singular)

2305 ↗(On Diff #19722)
(only GitHub-related lines are shown):</para>
mat marked 15 inline comments as done.Aug 29 2016, 2:14 PM
mat added inline comments.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2232 ↗(On Diff #19722)

Ah, yes, igor does not report it :-p

2300 ↗(On Diff #19722)

Because i said so, 4 lines above, it gives more meaning to it. And I did not want to repeat myself :-)
It's more interesting to use v3.4.0 as it show it is using a "release" and not a specific hash that upstream picked out of a hat.

Also, it has the advantage that if there is a wxsqlite3 port using github and using version 3.4.0, its distfile will be the same, and you get one distfile for two ports and save some space.

mat marked 2 inline comments as done.
  • With wblock's comments.
  • Add it to option helpers.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
2300 ↗(On Diff #19722)

Above, it just says "will provide more meaningful information". It doesn't tell how the information given is more meaningful. If it isn't possible to be more specific, probably better to make this imperative rather than a suggestion:

Both can be used
interchangeably, but when a tag is available, use it.</para>

This was committed in rD49366.

This revision was automatically updated to reflect the committed changes.