##// END OF EJS Templates
wireproto: support /api/* URL space for exposing APIs...
wireproto: support /api/* URL space for exposing APIs I will soon be introducing a new version of the HTTP wire protocol. One of the things I want to change with it is the URL routing. I want to rely on URL paths to define endpoints rather than the "cmd" query string argument. That should be pretty straightforward. I was thinking about what URL space to reserve for the new protocol. We /could/ put everything at a top-level path. e.g. /wireproto/* or /http-v2-wireproto/*. However, these constrain us a bit because they assume there will only be 1 API: version 2 of the HTTP wire protocol. I think there is room to grow multiple APIs. For example, there may someday be a proper JSON API to query or even manipulate the repository. And I don't think we should have to create a new top-level URL space for each API nor should we attempt to shoehorn each future API into the same shared URL space: that would just be too chaotic. This commits reserves the /api/* URL space for all our future API needs. Essentially, all requests to /api/* get routed to a new WSGI handler. By default, it 404's the entire URL space unless the "api server" feature is enabled. When enabled, requests to "/api" list available APIs. URLs of the form /api/<name>/* are reserved for a particular named API. Behavior within each API is left up to that API. So, we can grow new APIs easily without worrying about URL space conflicts. APIs can be registered by adding entries to a global dict. This allows extensions to provide their own APIs should they choose to do so. This is probably a premature feature. But IMO the code is easier to read if we're not dealing with API-specific behavior like config option querying inline. To prove it works, we implement a very basic API for version 2 of the HTTP wire protocol. It does nothing of value except facilitate testing of the /api/* URL space. We currently emit plain text responses for all /api/* endpoints. There's definitely room to look at Accept and other request headers to vary the response format. But we have to start somewhere. Differential Revision: https://phab.mercurial-scm.org/D2834

File last commit:

r32608:85b97803 stable
r37064:1cfef569 default
Show More
pager.txt
43 lines | 1.4 KiB | text/plain | TextLexer
Matt Harbison
help: attempt to clarify that pager usage is not output length based...
r32138 Some Mercurial commands can produce a lot of output, and Mercurial will
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 attempt to use a pager to make those commands more pleasant.
To set the pager that should be used, set the application variable::
[pager]
pager = less -FRX
Xavier Lepaul
help: clarify the choice of pager...
r32608 If no pager is set in the user or repository configuration, Mercurial uses the
environment variable $PAGER. If $PAGER is not set, pager.pager from the default
or system configuration is used. If none of these are set, a default pager will
be used, typically `less` on Unix and `more` on Windows.
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061
Matt Harbison
help: document color/pager pitfalls on Windows...
r32137 .. container:: windows
On Windows, `more` is not color aware, so using it effectively disables color.
MSYS and Cygwin shells provide `less` as a pager, which can be configured to
support ANSI color codes. See :hg:`help config.color.pagermode` to configure
the color mode when invoking a pager.
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 You can disable the pager for certain commands by adding them to the
pager.ignore list::
[pager]
ignore = version, help, update
To ignore global commands like :hg:`version` or :hg:`help`, you have
to specify them in your user configuration file.
To control whether the pager is used at all for an individual command,
FUJIWARA Katsunori
help: apply bulk fixes for indentation and literal blocking issues...
r32085 you can use --pager=<value>:
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061
- use as needed: `auto`.
- require the pager: `yes` or `on`.
- suppress the pager: `no` or `off` (any unrecognized value
FUJIWARA Katsunori
help: apply bulk fixes for indentation and literal blocking issues...
r32085 will also work).
Augie Fackler
pager: add a config knob to just globally turn off the pager
r31062
To globally turn off all attempts to use a pager, set::
Pierre-Yves David
pager: rename 'pager.enable' to 'ui.paginate'...
r32105 [ui]
paginate = never
Augie Fackler
pager: add a config knob to just globally turn off the pager
r31062
which will prevent the pager from running.