upstream/mercurial-mirror Files · mercurial/templates/gitweb/help.tmpl

help: document bundle specifications...

help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 76104a4899ad. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.

av6 - - Load All Authors

File last commit:

r27548:435c9068 default


                r31793:69d8fcf2

default

Download file

             help.tmpl
        
                    34 lines
            
             | 1.1 KiB
            
                | application/x-cheetah
            
             |
                CheetahLexer
            
             / mercurial / templates / gitweb / help.tmpl
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      {header}

      <title>Help: {topic}</title>

      <link rel="alternate" type="application/atom+xml"

         href="{url|urlescape}atom-log" title="Atom feed for {repo|escape}"/>

      <link rel="alternate" type="application/rss+xml"

         href="{url|urlescape}rss-log" title="RSS feed for {repo|escape}"/>

      </head>

      <body>

      <div class="page_header">

      <a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>

      <a href="/">Mercurial</a> {pathdef%breadcrumb} / help

      </div>

      <div class="page_nav">

      <a href="{url|urlescape}summary{sessionvars%urlparameter}">summary</a> |

      <a href="{url|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a> |

      <a href="{url|urlescape}log{sessionvars%urlparameter}">changelog</a> |

      <a href="{url|urlescape}graph{sessionvars%urlparameter}">graph</a> |

      <a href="{url|urlescape}tags{sessionvars%urlparameter}">tags</a> |

      <a href="{url|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a> |

      <a href="{url|urlescape}branches{sessionvars%urlparameter}">branches</a> |

      <a href="{url|urlescape}file{sessionvars%urlparameter}">files</a> |

      help

      <br/>

      </div>

      <div class="title">&nbsp;</div>

      <div id="doc">

      {rstdoc(doc, "html")}

      </div>

      {footer}

	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

				{header}
				<title>Help: {topic}</title>
				<link rel="alternate" type="application/atom+xml"
				href="{url\|urlescape}atom-log" title="Atom feed for {repo\|escape}"/>
				<link rel="alternate" type="application/rss+xml"
				href="{url\|urlescape}rss-log" title="RSS feed for {repo\|escape}"/>
				</head>
				<body>

				<div class="page_header">
				<a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>
				<a href="/">Mercurial</a> {pathdef%breadcrumb} / help
				</div>

				<div class="page_nav">
				<a href="{url\|urlescape}summary{sessionvars%urlparameter}">summary</a> \|
				<a href="{url\|urlescape}shortlog{sessionvars%urlparameter}">shortlog</a> \|
				<a href="{url\|urlescape}log{sessionvars%urlparameter}">changelog</a> \|
				<a href="{url\|urlescape}graph{sessionvars%urlparameter}">graph</a> \|
				<a href="{url\|urlescape}tags{sessionvars%urlparameter}">tags</a> \|
				<a href="{url\|urlescape}bookmarks{sessionvars%urlparameter}">bookmarks</a> \|
				<a href="{url\|urlescape}branches{sessionvars%urlparameter}">branches</a> \|
				<a href="{url\|urlescape}file{sessionvars%urlparameter}">files</a> \|
				help
				<br/>
				</div>

				<div class="title"> </div>

				<div id="doc">
				{rstdoc(doc, "html")}
				</div>

				{footer}