upstream/mercurial-mirror Files · mercurial/scmposix.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.

Pulkit Goyal - - Load All Authors

File last commit:

r31339:7c09b071 default


                r31793:69d8fcf2

default

Download file

             scmposix.py
        
                    79 lines
            
             | 2.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / mercurial / scmposix.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      from __future__ import absolute_import

      import array

      import errno

      import fcntl

      import os

      import sys

      from . import (

          encoding,

          osutil,

          pycompat,

      )

      def _rcfiles(path):

          rcs = [os.path.join(path, 'hgrc')]

          rcdir = os.path.join(path, 'hgrc.d')

          try:

              rcs.extend([os.path.join(rcdir, f)

                          for f, kind in osutil.listdir(rcdir)

                          if f.endswith(".rc")])

          except OSError:

              pass

          return rcs

      def systemrcpath():

          path = []

          if pycompat.sysplatform == 'plan9':

              root = 'lib/mercurial'

          else:

              root = 'etc/mercurial'

          # old mod_python does not set sys.argv

          if len(getattr(sys, 'argv', [])) > 0:

              p = os.path.dirname(os.path.dirname(pycompat.sysargv[0]))

              if p != '/':

                  path.extend(_rcfiles(os.path.join(p, root)))

          path.extend(_rcfiles('/' + root))

          return path

      def userrcpath():

          if pycompat.sysplatform == 'plan9':

              return [encoding.environ['home'] + '/lib/hgrc']

          elif pycompat.sysplatform == 'darwin':

              return [os.path.expanduser('~/.hgrc')]

          else:

              confighome = encoding.environ.get('XDG_CONFIG_HOME')

              if confighome is None or not os.path.isabs(confighome):

                  confighome = os.path.expanduser('~/.config')

              return [os.path.expanduser('~/.hgrc'),

                      os.path.join(confighome, 'hg', 'hgrc')]

      def termsize(ui):

          try:

              import termios

              TIOCGWINSZ = termios.TIOCGWINSZ  # unavailable on IRIX (issue3449)

          except (AttributeError, ImportError):

              return 80, 24

          for dev in (ui.ferr, ui.fout, ui.fin):

              try:

                  try:

                      fd = dev.fileno()

                  except AttributeError:

                      continue

                  if not os.isatty(fd):

                      continue

                  arri = fcntl.ioctl(fd, TIOCGWINSZ, '\0' * 8)

                  height, width = array.array(r'h', arri)[:2]

                  if width > 0 and height > 0:

                      return width, height

              except ValueError:

                  pass

              except IOError as e:

                  if e[0] == errno.EINVAL:

                      pass

                  else:

                      raise

          return 80, 24

	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

				from __future__ import absolute_import

				import array
				import errno
				import fcntl
				import os
				import sys

				from . import (
				encoding,
				osutil,
				pycompat,
				)

				def _rcfiles(path):
				rcs = [os.path.join(path, 'hgrc')]
				rcdir = os.path.join(path, 'hgrc.d')
				try:
				rcs.extend([os.path.join(rcdir, f)
				for f, kind in osutil.listdir(rcdir)
				if f.endswith(".rc")])
				except OSError:
				pass
				return rcs

				def systemrcpath():
				path = []
				if pycompat.sysplatform == 'plan9':
				root = 'lib/mercurial'
				else:
				root = 'etc/mercurial'
				# old mod_python does not set sys.argv
				if len(getattr(sys, 'argv', [])) > 0:
				p = os.path.dirname(os.path.dirname(pycompat.sysargv[0]))
				if p != '/':
				path.extend(_rcfiles(os.path.join(p, root)))
				path.extend(_rcfiles('/' + root))
				return path

				def userrcpath():
				if pycompat.sysplatform == 'plan9':
				return [encoding.environ['home'] + '/lib/hgrc']
				elif pycompat.sysplatform == 'darwin':
				return [os.path.expanduser('~/.hgrc')]
				else:
				confighome = encoding.environ.get('XDG_CONFIG_HOME')
				if confighome is None or not os.path.isabs(confighome):
				confighome = os.path.expanduser('~/.config')

				return [os.path.expanduser('~/.hgrc'),
				os.path.join(confighome, 'hg', 'hgrc')]

				def termsize(ui):
				try:
				import termios
				TIOCGWINSZ = termios.TIOCGWINSZ # unavailable on IRIX (issue3449)
				except (AttributeError, ImportError):
				return 80, 24

				for dev in (ui.ferr, ui.fout, ui.fin):
				try:
				try:
				fd = dev.fileno()
				except AttributeError:
				continue
				if not os.isatty(fd):
				continue
				arri = fcntl.ioctl(fd, TIOCGWINSZ, '\0' * 8)
				height, width = array.array(r'h', arri)[:2]
				if width > 0 and height > 0:
				return width, height
				except ValueError:
				pass
				except IOError as e:
				if e[0] == errno.EINVAL:
				pass
				else:
				raise
				return 80, 24