upstream/mercurial-mirror Files · mercurial/help/internals/requirements.txt

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

Augie Fackler - - Load All Authors

File last commit:

r36391:0147a473 default


                r37064:1cfef569

default

Download file

             requirements.txt
        
                    131 lines
            
             | 4.1 KiB
            
                | text/plain
            
             |
                TextLexer

/ mercurial / help / internals / requirements.txt

History | Source | Raw |Copy content |Copy permalink

Gregory Szorc help: document requirements...	r28523	Repositories contain a file (``.hg/requires``) containing a list of
		features/capabilities that are required for clients to interface
		with the repository. This file has been present in Mercurial since
		version 0.9.2 (released December 2006).

		One of the first things clients do when opening a repository is read
		``.hg/requires`` and verify that all listed requirements are supported,
		aborting if not. Requirements are therefore a strong mechanism to
		prevent incompatible clients from reading from unknown repository
		formats or even corrupting them by writing to them.

		Extensions may add requirements. When they do this, clients not running
		an extension will be unable to read from repositories.

		The following sections describe the requirements defined by the
		Mercurial core distribution.

		revlogv1
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	========
Gregory Szorc help: document requirements...	r28523
		When present, revlogs are version 1 (RevlogNG). RevlogNG was introduced
		in 2006. The ``revlogv1`` requirement has been enabled by default
		since the ``requires`` file was introduced in Mercurial 0.9.2.

		If this requirement is not present, version 0 revlogs are assumed.

		store
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	=====
Gregory Szorc help: document requirements...	r28523
		The store repository layout should be used.

		This requirement has been enabled by default since the ``requires`` file
		was introduced in Mercurial 0.9.2.

		fncache
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	=======
Gregory Szorc help: document requirements...	r28523
		The fncache repository layout should be used.

		The fncache layout hash encodes filenames with long paths and
		encodes reserved filenames.

		This requirement is enabled by default when the store requirement is
		enabled (which is the default behavior). It was introduced in Mercurial
		1.1 (released December 2008).

		shared
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	======
Gregory Szorc help: document requirements...	r28523
		Denotes that the store for a repository is shared from another location
		(defined by the ``.hg/sharedpath`` file).

		This requirement is set when a repository is created via :hg:`share`.

		The requirement was added in Mercurial 1.3 (released July 2009).

Dan Villiom Podlaski Christiansen share: add --relative flag to store a relative path to the source...	r31133	relshared
		=========

		Derivative of ``shared``; the location of the store is relative to the
		store of this repository.

		This requirement is set when a repository is created via :hg:`share`
		using the ``--relative`` option.

		The requirement was added in Mercurial 4.2 (released May 2017).

Gregory Szorc help: document requirements...	r28523	dotencode
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	=========
Gregory Szorc help: document requirements...	r28523
		The dotencode repository layout should be used.

		The dotencode layout encodes the first period or space in filenames
		to prevent issues on OS X and Windows.

		This requirement is enabled by default when the store requirement
		is enabled (which is the default behavior). It was introduced in
		Mercurial 1.7 (released November 2010).

		parentdelta
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	===========
Gregory Szorc help: document requirements...	r28523
		Denotes a revlog delta encoding format that was experimental and
		replaced by generaldelta. It should not be seen in the wild because
		it was never enabled by default.

		This requirement was added in Mercurial 1.7 and removed in Mercurial
		1.9.

		generaldelta
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	============
Gregory Szorc help: document requirements...	r28523
		Revlogs should be created with the generaldelta flag enabled. The
		generaldelta flag will cause deltas to be encoded against a parent
		revision instead of the previous revision in the revlog.

		Support for this requirement was added in Mercurial 1.9 (released
		July 2011). The requirement was disabled on new repositories by
		default until Mercurial 3.7 (released February 2016).

		manifestv2
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	==========
Gregory Szorc help: document requirements...	r28523
		Denotes that version 2 of manifests are being used.

		Support for this requirement was added in Mercurial 3.4 (released
Augie Fackler cleanup: say goodbye to manifestv2 format...	r36391	May 2015). The new format failed to meet expectations and support
		for the format and requirement were removed in Mercurial 4.6
		(released May 2018) since the feature never graduated frome experiment
		status.
Gregory Szorc help: document requirements...	r28523
		treemanifest
Gregory Szorc help: don't try to render a section on sub-topics...	r29747	============
Gregory Szorc help: document requirements...	r28523
		Denotes that tree manifests are being used. Tree manifests are
		one manifest per directory (as opposed to a single flat manifest).

		Support for this requirement was added in Mercurial 3.4 (released
		August 2015). The requirement is currently experimental and is
		disabled by default.
Gregory Szorc sparse: add a requirement when a repository uses sparse (BC)...	r33556
		exp-sparse
		==========

		The working directory is sparse (only contains a subset of files).

		Support for this requirement was added in Mercurial 4.3 (released
		August 2017). This requirement and feature are experimental and may
		disappear in a future Mercurial release. The requirement will only
		be present on repositories that have opted in to a sparse working
		directory.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages