suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

raco pkg Git workflow explanation: clarify pushing to a different repo

Browse Source
This commit is contained in:
Matthew Flatt 2015-03-27 09:15:18 -06:00
parent df9cd3342a
commit 7408ee4709
1 changed files with 37 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
pkgs/racket-doc/pkg/scribblings/git-workflow.scrbl
View File

@ -56,6 +56,12 @@ pull updates to local package repositories when checking dependencies.
For example, @exec{@command{update} --all} pulls updates for all For example, @exec{@command{update} --all} pulls updates for all
linked package repositories. linked package repositories.
A @tech{package source} provided with @DFlag{clone} can include a
branch and/or path into the repository. The branch specification
affects the branch used for the initial checkout, while a non-empty
path causes a subdirectory of the checkout to be linked for the
package.
Suppose that a developer works with a large number of packages and Suppose that a developer works with a large number of packages and
develops only a few of them. The intended workflow is as follows: develops only a few of them. The intended workflow is as follows:
@ -88,17 +94,43 @@ develops only a few of them. The intended workflow is as follows:
A suitable @nonterm{catalog} might be @url{http://pkgs.racket-lang.org}.} A suitable @nonterm{catalog} might be @url{http://pkgs.racket-lang.org}.}
@item{If the cloned Git repository is not the one where you want to
push and pull updates, use @exec{git} commands to add or change the
remote in your clone. For example, the command
@commandline{git remote set-url origin @nonterm{url}}
in the clone's directory causes @exec{git pull} and @exec{git push}
to pull and push to the given @nonterm{url}.
Alternatively, use @exec{git} to clone the target @nonterm{url}
first, and then supply the local clone's path as @nonterm{dir} in
@commandline{@command{update} --clone @nonterm{dir} @nonterm{pkg-name}}
Either way, when @command{update} pulls updates to the clone, it
will still pull them from the repository corresponding to
@nonterm{pkg-name}'s old source, and not from the @exec{git remote}
@nonterm{url}. Usually, that's what package developers want; when
they're not actively modifying a package, other developers' updates
should be pulled from the package's main repository. In case where
@nonterm{url} is the preferred source of updates for
@command{update}, use @nonterm{url} in
@commandline{@command{update} --clone @nonterm{dir} @nonterm{url}}
Beware, however, that @command{update} may be less able to detect
repository sharing among multiple packages (and keep the package
installations consistently associated with a particular clone)
when an alternative @nonterm{url} is provided.}
@item{Manage changes to each of the developed packages in the usual @item{Manage changes to each of the developed packages in the usual
way with @exec{git} tools, but @command-ref{update} is also available way with @exec{git} tools, but @command-ref{update} is also available
for updates, including mass updates.} for updates, including mass updates.}
] ]
A @tech{package source} provided with @DFlag{clone} can include a @section{Interactions Between @exec{git} and @exec{raco pkg}}
branch and/or path into the repository. The branch specification
affects the branch used for the initial checkout, while a non-empty
path causes a subdirectory of the checkout to be linked for the
package.
The @exec{git} and @exec{raco pkg} tools interact in specific The @exec{git} and @exec{raco pkg} tools interact in specific
ways: ways: