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

hgweb: add HTML elements to control whitespace settings for annotate...

hgweb: add HTML elements to control whitespace settings for annotate Building on top of the new URL query string arguments to control whitespace settings for annotate, this commit adds HTML checkboxes reflecting the values of these arguments to the paper and gitweb themes. The actual diff settings are now exported to the templating layer. The HTML templates add these as data-* attributes so they are accessible to the DOM. A new <form> with various <input> elements is added. The <form> is initially hidden via CSS. A shared JavaScript function (which runs after the <form> has been rendered but before the annotate HTML (because annotate HTML could take a while to load and we want the form to render quickly) takes care of setting the checked state of each box from the data-* attributes. It also registers an event handler to modify the URL and refresh the page whenever the checkbox state is changed. I'm using the URLSearchParams interface to perform URL manipulation. https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams tells me this may not be supported on older web browsers. Yes, apparently the web API didn't have a standard API to parse and format query strings until recently. Hence the check for the presence of this feature in the JavaScript. If the browser doesn't support the feature, the <form> will remain hidden and behavior will like it currently is. We could polyfill this feature or implement our own query string parsing. But I'm lazy and this could be done as a follow-up if people miss it. We could certainly expand this feature to support more diff options (such as lines of context). That's why the potentially reusable code is stored in a reusable place. It is also certainly possible to add diff controls to other pages that display diffs. But since Mozillians are making noise about controlling which revisions annotate shows, I figured I'd start there. .. feature:: Control whitespace settings for annotation on hgweb /annotate URLs on hgweb now accept query string arguments to influence how whitespace changes impact results. The arguments "ignorews," "ignorewsamount," "ignorewseol," and "ignoreblanklines" now have the same meaning as their [annotate] config section counterparts. Any provided setting overrides the server default. HTML checkboxes have been added to the paper and gitweb themes to expose current whitespace settings and to easily modify the current view. Differential Revision: https://phab.mercurial-scm.org/D850

Gregory Szorc - - Load All Authors

File last commit:

r33556:22371eab default


                r34392:6797f1fb

default

Download file

             requirements.txt
        
                    130 lines
            
             | 4.0 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
		May 2015). The requirement is currently experimental and is disabled
		by default.

		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