Nemcio/git-remote-hg
1
0
Fork 0
mirror of https://github.com/mnauw/git-remote-hg.git synced 2025-10-27 14:46:06 +01:00
Code Issues Packages Projects Releases Activity

README: update documentation with latest changes on fetching

Browse Source
This commit is contained in:
Mark Nauwelaerts
2016-08-13 13:49:48 +02:00
parent 5999a10519
commit a7ea76788c
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.asciidoc
View File

@@ -27,6 +27,7 @@ to be appropriately merged upstream):
* adds a 'git-hg-helper' script than can aid in the git-hg interaction workflow * adds a 'git-hg-helper' script than can aid in the git-hg interaction workflow
* provides enhanced bidirectional git-hg safety * provides enhanced bidirectional git-hg safety
* avoids clutter of `refs/hg/...` by keeping these implementation details really private * avoids clutter of `refs/hg/...` by keeping these implementation details really private
* more robust and efficient fetching
See sections below or sidemarked notes for more details. See sections below or sidemarked notes for more details.
**** ****
@@ -191,11 +192,12 @@ To tweak how 'git-remote-hg' decides on a copy/rename, use e.g:
== Additional Features == == Additional Features ==
=== Miscellaneous Tweaks === === Miscellaneous Tweaks ===
Other than <<no-limitations, removing the limitations>> as mentioned above, Other than <<no-limitations, removing the limitations>> as mentioned above,
a number of issues (either so reported in issue tracking or not) have been a number of issues (either so reported in
addressed here (e.g. notes handling, `fetch --prune` support, etc), some of https://github.com/felipec/git-remote-hg/issues[issue tracking] or not) have been
which have been highlighted above. addressed here, e.g. notes handling, `fetch --prune` support, recovering
from a `strip` on remote repo, tracking remote changes to import (if any) in a
safe, robust and efficient way, etc. Some of these have been highlighted above.
For example, the `refs/hg/...` refs are really an implementation detail For example, the `refs/hg/...` refs are really an implementation detail
that need not clutter up the (visible) ref space. So, in as much as they that need not clutter up the (visible) ref space. So, in as much as they
@@ -213,9 +215,7 @@ a remote helper. This is similar to e.g. 'git-svn' being a separate program
altogether. These subcommands altogether. These subcommands
* provide conversion from a hg changeset id to a git commit hash, or vice versa * provide conversion from a hg changeset id to a git commit hash, or vice versa
* provide consistency maintenance on internal `git-remote-hg` metadata marks, * provide consistency and cleanup maintenance on internal `git-remote-hg` metadata marks
which might on occasion be required or useful for efficiency
(e.g. to avoid full fetch history processing following strip on a large Mercurial repo).
* provide optimization of git marks of a fetch-only remote * provide optimization of git marks of a fetch-only remote
See the helper script commands' help description for further details. See the helper script commands' help description for further details.
@@ -226,11 +226,13 @@ as `git hg`:
% git config --global alias.hg '!git-hg-helper' % git config --global alias.hg '!git-hg-helper'
-------------------------------------- --------------------------------------
With that in place, running `git hg marks <remote>` after initial fetch from (large) With that in place, running `git hg gc <remote>` after initial fetch from (large)
<remote> will save quite some space in the git marks file. Not to mention some time <remote> will save quite some space in the git marks file. Not to mention some time
each time is loaded and saved again (upon fetch). If the remote is ever pushed each time it is loaded and saved again (upon fetch). If the remote is ever pushed
to, the marks file will similarly be squashed, but for a fetch-only <remote> to, the marks file will similarly be squashed, but for a fetch-only <remote>
the aforementioned command will do. the aforementioned command will do. It may also be needed to run aforementioned
command after a `git gc` has been performed. You will notice the need
when `git-fast-import` or `git-fast-export` complain about not finding objects ;-)
In addition, the helper also provides support routines for `git-remote-hg` that In addition, the helper also provides support routines for `git-remote-hg` that
provide for increased (or at least safer) git-hg bidirectionality. provide for increased (or at least safer) git-hg bidirectionality.