upstream/mercurial-mirror Files · mercurial/templates/gitweb/helptopics.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:

r30019:6ca3c54f default


                r31793:69d8fcf2

default

Download file

             helptopics.tmpl
        
                    48 lines
            
             | 1.6 KiB
            
                | application/x-cheetah
            
             |
                CheetahLexer
            
             / mercurial / templates / gitweb / helptopics.tmpl
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      {header}

        av6
    
hgweb: fix help pages title in gitweb and monoblue...

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

        Augie Fackler
    
web: add a help view for getting hg help output

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

        av6
    
gitweb: link to the correct feeds from help pages

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

        Augie Fackler
    
web: add a help view for getting hg help output

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

        av6
    
gitweb: link to the correct feeds from help pages

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

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      </head>

      <body>

      <div class="page_header">

        Angel Ezquerra <angel.ezquerra at gmail.com>
    
hgweb: add a "URL breadcrumb" to the index and repository pages...

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

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

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      </div>

      <div class="page_nav">

        Thomas Arendsen Hein
    
hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...

              r18526
            
      <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> |

        av6
    
hgweb: don't point file links at tip hash where it doesn't make sense...

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

        Gregory Szorc
    
templates: support linking to main help page...

              r27580
            
      {if(subindex,

        '<a href="{url|urlescape}help{sessionvars%urlparameter}">help</a>',

        'help'

      )}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      <br/>

      </div>

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

      <table cellspacing="0">

        av6
    
hgweb: make anchor name actually match its href on help index page

              r30019
            
      <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      {topics % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
      {if(earlycommands, '

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>

      {earlycommands % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
      ')}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
      {if(othercommands, '

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>

      {othercommands % helpentry}

        Gregory Szorc
    
templates: make earlycommands and othercommands optional...

              r27578
            
      ')}

        Augie Fackler
    
web: add a help view for getting hg help output

              r12666
            
      </table>

      {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

Augie Fackler web: add a help view for getting hg help output	r12666	{header}
av6 hgweb: fix help pages title in gitweb and monoblue...	r25686	<title>Help: {title}</title>
Augie Fackler web: add a help view for getting hg help output	r12666	<link rel="alternate" type="application/atom+xml"
av6 gitweb: link to the correct feeds from help pages	r27548	href="{url\|urlescape}atom-log" title="Atom feed for {repo\|escape}"/>
Augie Fackler web: add a help view for getting hg help output	r12666	<link rel="alternate" type="application/rss+xml"
av6 gitweb: link to the correct feeds from help pages	r27548	href="{url\|urlescape}rss-log" title="RSS feed for {repo\|escape}"/>
Augie Fackler web: add a help view for getting hg help output	r12666	</head>
		<body>

		<div class="page_header">
Angel Ezquerra <angel.ezquerra at gmail.com> hgweb: add a "URL breadcrumb" to the index and repository pages...	r18258	<a href="{logourl}" title="Mercurial" style="float: right;">Mercurial</a>
		<a href="/">Mercurial</a> {pathdef%breadcrumb} / help
Augie Fackler web: add a help view for getting hg help output	r12666	</div>

		<div class="page_nav">
Thomas Arendsen Hein hgweb: urlescape all urls, HTML escape repo/tag/branch/... names...	r18526	<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> \|
av6 hgweb: don't point file links at tip hash where it doesn't make sense...	r25526	<a href="{url\|urlescape}file{sessionvars%urlparameter}">files</a> \|
Gregory Szorc templates: support linking to main help page...	r27580	{if(subindex,
		'<a href="{url\|urlescape}help{sessionvars%urlparameter}">help</a>',
		'help'
		)}
Augie Fackler web: add a help view for getting hg help output	r12666	<br/>
		</div>

		<div class="title"> </div>
		<table cellspacing="0">
av6 hgweb: make anchor name actually match its href on help index page	r30019	<tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
Augie Fackler web: add a help view for getting hg help output	r12666	{topics % helpentry}

Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	{if(earlycommands, '
Augie Fackler web: add a help view for getting hg help output	r12666	<tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
		{earlycommands % helpentry}
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	')}
Augie Fackler web: add a help view for getting hg help output	r12666
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	{if(othercommands, '
Augie Fackler web: add a help view for getting hg help output	r12666	<tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
		{othercommands % helpentry}
Gregory Szorc templates: make earlycommands and othercommands optional...	r27578	')}

Augie Fackler web: add a help view for getting hg help output	r12666	</table>

		{footer}