This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2278

bundle: updates the help text for hg bundle (issue5744) [bugzilla]
ClosedPublic

Authored by khanchi97 on Feb 15 2018, 8:12 AM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHG2892c1d47f30: bundle: updates the help text for hg bundle (issue5744)
rHGff36116f30f3: bundle: updates the help text for hg bundle (issue5744)

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

khanchi97 created this revision.Feb 15 2018, 8:12 AM
yuja requested changes to this revision.Feb 16 2018, 7:23 AM
yuja added a subscriber: yuja.
yuja added inline comments.
mercurial/commands.py
1161

"probably a repository" ?

If --all given, the generated bundle isn't intended to be added to the DEST repository.

1167–1168

Here the destination repository is described. I think we can instead refine
this paragraph to clarify what the DEST is.

This revision now requires changes to proceed.Feb 16 2018, 7:23 AM
khanchi97 updated this revision to Diff 5778.Feb 16 2018, 2:25 PM
yuja requested changes to this revision.Feb 16 2018, 10:41 PM
yuja added inline comments.
mercurial/commands.py
1165

where the destination repository isn't DEST. :)
--base and --all are the options incompatible with DEST.

Can you move this to the last sentence?

This revision now requires changes to proceed.Feb 16 2018, 10:41 PM
khanchi97 updated this revision to Diff 5794.Feb 17 2018, 12:19 AM
yuja accepted this revision.Feb 17 2018, 7:29 AM
This revision is now accepted and ready to land.Feb 17 2018, 7:29 AM
yuja added a comment.Feb 17 2018, 7:31 AM

Queued, thanks. Dropped [ ] from [DEST] because [] is the notation
meaning that the DEST argument may be omitted.

Closed by commit rHGff36116f30f3: bundle: updates the help text for hg bundle (issue5744) (authored by khanchi97). · Explain WhyFeb 17 2018, 7:43 AM
This revision was automatically updated to reflect the committed changes.
pulkit added a subscriber: pulkit.Feb 18 2018, 8:22 AM

For future bug fixes: we don't append [bugzilla] at the end of commits which fixes bug, we only mention the issue number. We only use bugzilla for bugs/issues so an issue number in the commit message refers to the issue on bugzilla.

khanchi97 added a comment.Feb 18 2018, 8:29 AM

Okay, I will take care of that.

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (6 lines)

Diff 5809

mercurial/commands.py

_('REV')), _('REV')),
('a', 'all', None, _('bundle all changesets in the repository')), ('a', 'all', None, _('bundle all changesets in the repository')),
('t', 'type', 'bzip2', _('bundle compression type to use'), _('TYPE')), ('t', 'type', 'bzip2', _('bundle compression type to use'), _('TYPE')),
] + remoteopts, ] + remoteopts,
_('[-f] [-t BUNDLESPEC] [-a] [-r REV]... [--base REV]... FILE [DEST]')) _('[-f] [-t BUNDLESPEC] [-a] [-r REV]... [--base REV]... FILE [DEST]'))
def bundle(ui, repo, fname, dest=None, **opts): def bundle(ui, repo, fname, dest=None, **opts):
"""create a bundle file """create a bundle file
Generate a bundle file containing data to be added to a repository. Generate a bundle file containing data to be transferred to another
repository.
yujaUnsubmitted
Not Done

"probably a repository" ?

If --all given, the generated bundle isn't intended to be added to the DEST repository.

yuja: "probably a repository" ? If `--all` given, the generated bundle isn't intended to be added to…
To create a bundle containing all changesets, use -a/--all To create a bundle containing all changesets, use -a/--all
(or --base null). Otherwise, hg assumes the destination will have (or --base null). Otherwise, hg assumes the destination will have
all the nodes you specify with --base parameters. Otherwise, hg all the nodes you specify with --base parameters. Otherwise, hg
yujaUnsubmitted
Not Done

where the destination repository isn't DEST. :)
--base and --all are the options incompatible with DEST.

Can you move this to the last sentence?

yuja: where the destination repository isn't DEST. :) `--base` and `--all` are the options…
will assume the repository has all the nodes in destination, or will assume the repository has all the nodes in destination, or
default-push/default if no destination is specified. default-push/default if no destination is specified, where destination
is the repository you provide through DEST option.
yujaUnsubmitted
Not Done

Here the destination repository is described. I think we can instead refine
this paragraph to clarify what the DEST is.

yuja: Here the destination repository is described. I think we can instead refine this paragraph to…
You can change bundle format with the -t/--type option. See You can change bundle format with the -t/--type option. See
:hg:`help bundlespec` for documentation on this format. By default, :hg:`help bundlespec` for documentation on this format. By default,
the most appropriate format is used and compression defaults to the most appropriate format is used and compression defaults to
bzip2. bzip2.
The bundle file can then be transferred using conventional means The bundle file can then be transferred using conventional means
and applied to another repository with the unbundle or pull and applied to another repository with the unbundle or pull