Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`python`.`_release`.`GitCommand``

class documentation

`class GitCommand: (source)`

Implements interfaces: `twisted.python._release.IVCSCommand`

View In Hierarchy

Subset of Git commands to release Twisted from a Git repository.

Static Method | `ensureIsWorkingDirectory` | Ensure that `path` is a Git working directory.
Static Method | `exportTo` | Export the content of a Git repository to the specified directory.
Static Method | `isStatusClean` | Return the Git status of the files in the specified path.
Static Method | `remove` | Remove the specified path from a Git repository.

@staticmethod
def ensureIsWorkingDirectory(path): (source)
from `twisted.python._release.IVCSCommand`

Ensure that `path` is a Git working directory.

Parameters
path:`twisted.python.filepath.FilePath` | The path to check.

@staticmethod
def exportTo(fromDir, exportDir): (source)
from `twisted.python._release.IVCSCommand`

Export the content of a Git repository to the specified directory.

Parameters
fromDir:`twisted.python.filepath.FilePath` | The path to the Git repository to export.
exportDir:`twisted.python.filepath.FilePath` | The directory to export the content of the repository to. This directory doesn't have to exist prior to exporting the repository.

@staticmethod
def isStatusClean(path): (source)
from `twisted.python._release.IVCSCommand`

Return the Git status of the files in the specified path.

Parameters
path:`twisted.python.filepath.FilePath` | The path to get the status from (can be a directory or a file.)

@staticmethod
def remove(path): (source)
from `twisted.python._release.IVCSCommand`

Remove the specified path from a Git repository.

Parameters
path:`twisted.python.filepath.FilePath` | The path to remove from the repository.