| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1535,22 +1535,29 @@ def archive( | |||
| 1535 | 1535 | ) -> Repo: | |
| 1536 | 1536 | """Archive the tree at the given revision. | |
| 1537 | 1537 | ||
| 1538 | - :param ostream: file compatible stream object to which the archive will be written as bytes. | ||
| 1538 | + :param ostream: | ||
| 1539 | + File-compatible stream object to which the archive will be written as bytes. | ||
| 1539 | 1540 | ||
| 1540 | - :param treeish: is the treeish name/id, defaults to active branch. | ||
| 1541 | + :param treeish: | ||
| 1542 | + The treeish name/id, defaults to active branch. | ||
| 1541 | 1543 | ||
| 1542 | - :param prefix: is the optional prefix to prepend to each filename in the archive. | ||
| 1544 | + :param prefix: | ||
| 1545 | + The optional prefix to prepend to each filename in the archive. | ||
| 1543 | 1546 | ||
| 1544 | - :param kwargs: Additional arguments passed to git-archive: | ||
| 1547 | + :param kwargs: | ||
| 1548 | + Additional arguments passed to ``git archive``: | ||
| 1545 | 1549 | ||
| 1546 | - * Use the 'format' argument to define the kind of format. Use | ||
| 1547 | - specialized ostreams to write any format supported by python. | ||
| 1548 | - * You may specify the special **path** keyword, which may either be a repository-relative | ||
| 1549 | - path to a directory or file to place into the archive, or a list or tuple of multiple paths. | ||
| 1550 | + * Use the 'format' argument to define the kind of format. Use specialized | ||
| 1551 | + ostreams to write any format supported by Python. | ||
| 1552 | + * You may specify the special **path** keyword, which may either be a | ||
| 1553 | + repository-relative path to a directory or file to place into the archive, | ||
| 1554 | + or a list or tuple of multiple paths. | ||
| 1550 | 1555 | ||
| 1551 | - :raise GitCommandError: If something went wrong. | ||
| 1556 | + :raise GitCommandError: | ||
| 1557 | + If something went wrong. | ||
| 1552 | 1558 | ||
| 1553 | - :return: self | ||
| 1559 | + :return: | ||
| 1560 | + self | ||
| 1554 | 1561 | """ | |
| 1555 | 1562 | if treeish is None: | |
| 1556 | 1563 | treeish = self.head.commit | |
| Back | FazBrowse Home | New Git URL |
0 commit comments