This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6871

wireprototypes: clarify documentation of getbundle argument types
ClosedPublic

Authored by martinvonz on Sep 18 2019, 4:58 PM.

Details

Reviewers
marmoute
pulkit
Group Reviewers
hg-reviewers
Commits
rHG9668744c9122: wireprototypes: clarify documentation of getbundle argument types
Summary

It seems like it was a mix of what the Python code would see and what
was sent over the wire. I've tried to clarify both the type seen in
Python and how it's transmitted.

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

martinvonz created this revision.Sep 18 2019, 4:58 PM
marmoute accepted this revision.Sep 19 2019, 3:47 AM
pulkit accepted this revision.Sep 19 2019, 7:20 AM
This revision is now accepted and ready to land.Sep 19 2019, 7:20 AM

Revision Contents
Changeset List

PathPackages
Mmercurial/wireprototypes.py (10 lines)

Diff 16587

mercurial/wireprototypes.py

return (escaped return (escaped
.replace(':e', '=') .replace(':e', '=')
.replace(':s', ';') .replace(':s', ';')
.replace(':o', ',') .replace(':o', ',')
.replace(':c', ':')) .replace(':c', ':'))
# mapping of options accepted by getbundle and their types # mapping of options accepted by getbundle and their types
# #
# Meant to be extended by extensions. It is extensions responsibility to ensure # Meant to be extended by extensions. It is the extension's responsibility to
# such options are properly processed in exchange.getbundle. # ensure such options are properly processed in exchange.getbundle.
# #
# supported types are: # supported types are:
# #
# :nodes: list of binary nodes # :nodes: list of binary nodes, transmitted as space-separated hex nodes
# :csv: list of comma-separated values # :csv: list of values, transmitted as comma-separated values
# :scsv: list of comma-separated values return as set # :scsv: set of values, transmitted as comma-separated values
# :plain: string with no transformation needed. # :plain: string with no transformation needed.
GETBUNDLE_ARGUMENTS = { GETBUNDLE_ARGUMENTS = {
'heads': 'nodes', 'heads': 'nodes',
'bookmarks': 'boolean', 'bookmarks': 'boolean',
'common': 'nodes', 'common': 'nodes',
'obsmarkers': 'boolean', 'obsmarkers': 'boolean',
'phases': 'boolean', 'phases': 'boolean',
'bundlecaps': 'scsv', 'bundlecaps': 'scsv',