upstream/mercurial-mirror Files · mercurial/dirstateguard.py

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.

Augie Fackler - - Load All Authors

File last commit:

r30488:751639bf default


                r31793:69d8fcf2

default

Download file

             dirstateguard.py
        
                    69 lines
            
             | 2.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / mercurial / dirstateguard.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # dirstateguard.py - class to allow restoring dirstate after failure

      #

      # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>

      #

      # This software may be used and distributed according to the terms of the

      # GNU General Public License version 2 or any later version.

      from __future__ import absolute_import

      from .i18n import _

      from . import (

          error,

      )

      class dirstateguard(object):

          '''Restore dirstate at unexpected failure.

          At the construction, this class does:

          - write current ``repo.dirstate`` out, and

          - save ``.hg/dirstate`` into the backup file

          This restores ``.hg/dirstate`` from backup file, if ``release()``

          is invoked before ``close()``.

          This just removes the backup file at ``close()`` before ``release()``.

          '''

          def __init__(self, repo, name):

              self._repo = repo

              self._active = False

              self._closed = False

              self._suffix = '.backup.%s.%d' % (name, id(self))

              repo.dirstate.savebackup(repo.currenttransaction(), self._suffix)

              self._active = True

          def __del__(self):

              if self._active: # still active

                  # this may occur, even if this class is used correctly:

                  # for example, releasing other resources like transaction

                  # may raise exception before ``dirstateguard.release`` in

                  # ``release(tr, ....)``.

                  self._abort()

          def close(self):

              if not self._active: # already inactivated

                  msg = (_("can't close already inactivated backup: dirstate%s")

                         % self._suffix)

                  raise error.Abort(msg)

              self._repo.dirstate.clearbackup(self._repo.currenttransaction(),

                                               self._suffix)

              self._active = False

              self._closed = True

          def _abort(self):

              self._repo.dirstate.restorebackup(self._repo.currenttransaction(),

                                                 self._suffix)

              self._active = False

          def release(self):

              if not self._closed:

                  if not self._active: # already inactivated

                      msg = (_("can't release already inactivated backup:"

                               " dirstate%s")

                             % self._suffix)

                      raise error.Abort(msg)

                  self._abort()

	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

				# dirstateguard.py - class to allow restoring dirstate after failure
				#
				# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2 or any later version.

				from __future__ import absolute_import

				from .i18n import _

				from . import (
				error,
				)

				class dirstateguard(object):
				'''Restore dirstate at unexpected failure.

				At the construction, this class does:

				- write current ``repo.dirstate`` out, and
				- save ``.hg/dirstate`` into the backup file

				This restores ``.hg/dirstate`` from backup file, if ``release()``
				is invoked before ``close()``.

				This just removes the backup file at ``close()`` before ``release()``.
				'''

				def __init__(self, repo, name):
				self._repo = repo
				self._active = False
				self._closed = False
				self._suffix = '.backup.%s.%d' % (name, id(self))
				repo.dirstate.savebackup(repo.currenttransaction(), self._suffix)
				self._active = True

				def __del__(self):
				if self._active: # still active
				# this may occur, even if this class is used correctly:
				# for example, releasing other resources like transaction
				# may raise exception before ``dirstateguard.release`` in
				# ``release(tr, ....)``.
				self._abort()

				def close(self):
				if not self._active: # already inactivated
				msg = (_("can't close already inactivated backup: dirstate%s")
				% self._suffix)
				raise error.Abort(msg)

				self._repo.dirstate.clearbackup(self._repo.currenttransaction(),
				self._suffix)
				self._active = False
				self._closed = True

				def _abort(self):
				self._repo.dirstate.restorebackup(self._repo.currenttransaction(),
				self._suffix)
				self._active = False

				def release(self):
				if not self._closed:
				if not self._active: # already inactivated
				msg = (_("can't release already inactivated backup:"
				" dirstate%s")
				% self._suffix)
				raise error.Abort(msg)
				self._abort()