| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent e883293 commit d8ab99c
19 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -901,7 +901,8 @@ def working_dir(self) -> Union[None, PathLike]: | |||
| 901 | 901 | def version_info(self) -> Tuple[int, ...]: | |
| 902 | 902 | """ | |
| 903 | 903 | :return: Tuple with integers representing the major, minor and additional | |
| 904 | - version numbers as parsed from ``git version``. Up to four fields are used. | ||
| 904 | + version numbers as parsed from :manpage:`git-version(1)`. Up to four fields | ||
| 905 | + are used. | ||
| 905 | 906 | ||
| 906 | 907 | This value is generated on demand and is cached. | |
| 907 | 908 | """ | |
@@ -1038,9 +1039,9 @@ def execute( | |||
| 1038 | 1039 | 3. Deeper descendants do not receive signals, though they may sometimes | |
| 1039 | 1040 | terminate as a consequence of their parent processes being killed. | |
| 1040 | 1041 | 4. `kill_after_timeout` uses ``SIGKILL``, which can have negative side | |
| 1041 | - effects on a repository. For example, stale locks in case of ``git gc`` | ||
| 1042 | - could render the repository incapable of accepting changes until the lock | ||
| 1043 | - is manually removed. | ||
| 1042 | + effects on a repository. For example, stale locks in case of | ||
| 1043 | + :manpage:`git-gc(1)` could render the repository incapable of accepting | ||
| 1044 | + changes until the lock is manually removed. | ||
| 1044 | 1045 | ||
| 1045 | 1046 | :param with_stdout: | |
| 1046 | 1047 | If ``True``, default ``True``, we open stdout on the created process. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -270,7 +270,7 @@ def get_config_path(config_level: Lit_config_levels) -> str: | |||
| 270 | 270 | class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder): | |
| 271 | 271 | """Implements specifics required to read git style configuration files. | |
| 272 | 272 | ||
| 273 | - This variation behaves much like the ``git config`` command, such that the | ||
| 273 | + This variation behaves much like the :manpage:`git-config(1)` command, such that the | ||
| 274 | 274 | configuration will be read on demand based on the filepath given during | |
| 275 | 275 | initialization. | |
| 276 | 276 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -222,8 +222,8 @@ def diff( | |||
| 222 | 222 | to be read and diffed. | |
| 223 | 223 | ||
| 224 | 224 | :param kwargs: | |
| 225 | - Additional arguments passed to ``git diff``, such as ``R=True`` to swap both | ||
| 226 | - sides of the diff. | ||
| 225 | + Additional arguments passed to :manpage:`git-diff(1)`, such as ``R=True`` to | ||
| 226 | + swap both sides of the diff. | ||
| 227 | 227 | ||
| 228 | 228 | :return: | |
| 229 | 229 | A :class:`DiffIndex` representing the computed diff. | |
@@ -590,7 +590,7 @@ def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoIn | |||
| 590 | 590 | The repository we are operating on. | |
| 591 | 591 | ||
| 592 | 592 | :param proc: | |
| 593 | - ``git diff`` process to read from | ||
| 593 | + :manpage:`git-diff(1)` process to read from | ||
| 594 | 594 | (supports :class:`Git.AutoInterrupt <git.cmd.Git.AutoInterrupt>` wrapper). | |
| 595 | 595 | ||
| 596 | 596 | :return: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -225,11 +225,11 @@ def write( | |||
| 225 | 225 | ||
| 226 | 226 | :param ignore_extension_data: | |
| 227 | 227 | If ``True``, the TREE type extension data read in the index will not be | |
| 228 | - written to disk. NOTE that no extension data is actually written. | ||
| 229 | - Use this if you have altered the index and would like to use | ||
| 230 | - ``git write-tree`` afterwards to create a tree representing your written | ||
| 231 | - changes. If this data is present in the written index, ``git write-tree`` | ||
| 232 | - will instead write the stored/cached tree. | ||
| 228 | + written to disk. NOTE that no extension data is actually written. Use this | ||
| 229 | + if you have altered the index and would like to use | ||
| 230 | + :manpage:`git-write-tree(1)` afterwards to create a tree representing your | ||
| 231 | + written changes. If this data is present in the written index, | ||
| 232 | + :manpage:`git-write-tree(1)` will instead write the stored/cached tree. | ||
| 233 | 233 | Alternatively, use :meth:`write_tree` to handle this case automatically. | |
| 234 | 234 | """ | |
| 235 | 235 | # Make sure we have our entries read before getting a write lock. | |
@@ -343,7 +343,7 @@ def from_tree(cls, repo: "Repo", *treeish: Treeish, **kwargs: Any) -> "IndexFile | |||
| 343 | 343 | tree, tree 3 is the 'other' one. | |
| 344 | 344 | ||
| 345 | 345 | :param kwargs: | |
| 346 | - Additional arguments passed to ``git read-tree``. | ||
| 346 | + Additional arguments passed to :manpage:`git-read-tree(1)`. | ||
| 347 | 347 | ||
| 348 | 348 | :return: | |
| 349 | 349 | New :class:`IndexFile` instance. It will point to a temporary index location | |
@@ -355,9 +355,9 @@ def from_tree(cls, repo: "Repo", *treeish: Treeish, **kwargs: Any) -> "IndexFile | |||
| 355 | 355 | automatically resolve more cases in a commonly correct manner. Specify | |
| 356 | 356 | ``trivial=True`` as a keyword argument to override that. | |
| 357 | 357 | ||
| 358 | - As the underlying ``git read-tree`` command takes into account the current | ||
| 359 | - index, it will be temporarily moved out of the way to prevent any unexpected | ||
| 360 | - interference. | ||
| 358 | + As the underlying :manpage:`git-read-tree(1)` command takes into account the | ||
| 359 | + current index, it will be temporarily moved out of the way to prevent any | ||
| 360 | + unexpected interference. | ||
| 361 | 361 | """ | |
| 362 | 362 | if len(treeish) == 0 or len(treeish) > 3: | |
| 363 | 363 | raise ValueError("Please specify between 1 and 3 treeish, got %i" % len(treeish)) | |
@@ -470,10 +470,10 @@ def _write_path_to_stdin( | |||
| 470 | 470 | In that case, it will return ``None``. | |
| 471 | 471 | ||
| 472 | 472 | :note: | |
| 473 | - There is a bug in git-update-index that prevents it from sending reports | ||
| 474 | - just in time. This is why we have a version that tries to read stdout and | ||
| 475 | - one which doesn't. In fact, the stdout is not important as the piped-in | ||
| 476 | - files are processed anyway and just in time. | ||
| 473 | + There is a bug in :manpage:`git-update-index(1)` that prevents it from | ||
| 474 | + sending reports just in time. This is why we have a version that tries to | ||
| 475 | + read stdout and one which doesn't. In fact, the stdout is not important as | ||
| 476 | + the piped-in files are processed anyway and just in time. | ||
| 477 | 477 | ||
| 478 | 478 | :note: | |
| 479 | 479 | Newlines are essential here, git's behaviour is somewhat inconsistent on | |
@@ -782,11 +782,12 @@ def add( | |||
| 782 | 782 | directories like ``lib``, which will add all the files within the | |
| 783 | 783 | directory and subdirectories. | |
| 784 | 784 | ||
| 785 | - This equals a straight ``git add``. | ||
| 785 | + This equals a straight :manpage:`git-add(1)`. | ||
| 786 | 786 | ||
| 787 | 787 | They are added at stage 0. | |
| 788 | 788 | ||
| 789 | - - :class:~`git.objects.blob.Blob` or :class:`~git.objects.submodule.base.Submodule` object | ||
| 789 | + - :class:~`git.objects.blob.Blob` or | ||
| 790 | + :class:`~git.objects.submodule.base.Submodule` object | ||
| 790 | 791 | ||
| 791 | 792 | Blobs are added as they are assuming a valid mode is set. | |
| 792 | 793 | ||
@@ -818,8 +819,8 @@ def add( | |||
| 818 | 819 | :param force: | |
| 819 | 820 | **CURRENTLY INEFFECTIVE** | |
| 820 | 821 | If ``True``, otherwise ignored or excluded files will be added anyway. As | |
| 821 | - opposed to the ``git add`` command, we enable this flag by default as the | ||
| 822 | - API user usually wants the item to be added even though they might be | ||
| 822 | + opposed to the :manpage:`git-add(1)` command, we enable this flag by default | ||
| 823 | + as the API user usually wants the item to be added even though they might be | ||
| 823 | 824 | excluded. | |
| 824 | 825 | ||
| 825 | 826 | :param fprogress: | |
@@ -850,8 +851,8 @@ def add( | |||
| 850 | 851 | :param write_extension_data: | |
| 851 | 852 | If ``True``, extension data will be written back to the index. This can lead | |
| 852 | 853 | to issues in case it is containing the 'TREE' extension, which will cause | |
| 853 | - the ``git commit`` command to write an old tree, instead of a new one | ||
| 854 | - representing the now changed index. | ||
| 854 | + the :manpage:`git-commit(1)` command to write an old tree, instead of a new | ||
| 855 | + one representing the now changed index. | ||
| 855 | 856 | ||
| 856 | 857 | This doesn't matter if you use :meth:`IndexFile.commit`, which ignores the | |
| 857 | 858 | 'TREE' extension altogether. You should set it to ``True`` if you intend to | |
@@ -1008,8 +1009,8 @@ def remove( | |||
| 1008 | 1009 | uncommitted changes in it. | |
| 1009 | 1010 | ||
| 1010 | 1011 | :param kwargs: | |
| 1011 | - Additional keyword arguments to be passed to ``git rm``, such as ``r`` to | ||
| 1012 | - allow recursive removal. | ||
| 1012 | + Additional keyword arguments to be passed to :manpage:`git-rm(1)`, such as | ||
| 1013 | + ``r`` to allow recursive removal. | ||
| 1013 | 1014 | ||
| 1014 | 1015 | :return: | |
| 1015 | 1016 | List(path_string, ...) list of repository relative paths that have been | |
@@ -1058,7 +1059,7 @@ def move( | |||
| 1058 | 1059 | skipped. | |
| 1059 | 1060 | ||
| 1060 | 1061 | :param kwargs: | |
| 1061 | - Additional arguments you would like to pass to ``git mv``, such as | ||
| 1062 | + Additional arguments you would like to pass to :manpage:`git-mv(1)`, such as | ||
| 1062 | 1063 | ``dry_run`` or ``force``. | |
| 1063 | 1064 | ||
| 1064 | 1065 | :return: | |
@@ -1224,7 +1225,7 @@ def checkout( | |||
| 1224 | 1225 | prior and after a file has been checked out. | |
| 1225 | 1226 | ||
| 1226 | 1227 | :param kwargs: | |
| 1227 | - Additional arguments to be passed to ``git checkout-index``. | ||
| 1228 | + Additional arguments to be passed to :manpage:`git-checkout-index(1)`. | ||
| 1228 | 1229 | ||
| 1229 | 1230 | :return: | |
| 1230 | 1231 | Iterable yielding paths to files which have been checked out and are | |
@@ -1243,8 +1244,8 @@ def checkout( | |||
| 1243 | 1244 | The checkout is limited to checking out the files in the index. Files which | |
| 1244 | 1245 | are not in the index anymore and exist in the working tree will not be | |
| 1245 | 1246 | deleted. This behaviour is fundamentally different to ``head.checkout``, | |
| 1246 | - i.e. if you want ``git checkout`` like behaviour, use ``head.checkout`` | ||
| 1247 | - instead of ``index.checkout``. | ||
| 1247 | + i.e. if you want :manpage:`git-checkout(1)`-like behaviour, use | ||
| 1248 | + ``head.checkout`` instead of ``index.checkout``. | ||
| 1248 | 1249 | """ | |
| 1249 | 1250 | args = ["--index"] | |
| 1250 | 1251 | if force: | |
@@ -1416,14 +1417,14 @@ def reset( | |||
| 1416 | 1417 | raised. | |
| 1417 | 1418 | ||
| 1418 | 1419 | :param kwargs: | |
| 1419 | - Additional keyword arguments passed to ``git reset``. | ||
| 1420 | + Additional keyword arguments passed to :manpage:`git-reset(1)`. | ||
| 1420 | 1421 | ||
| 1421 | 1422 | :note: | |
| 1422 | 1423 | :meth:`IndexFile.reset`, as opposed to | |
| 1423 | 1424 | :meth:`HEAD.reset <git.refs.head.HEAD.reset>`, will not delete any files in | |
| 1424 | 1425 | order to maintain a consistent working tree. Instead, it will just check out | |
| 1425 | 1426 | the files according to their state in the index. | |
| 1426 | - If you want ``git reset``-like behaviour, use | ||
| 1427 | + If you want :manpage:`git-reset(1)`-like behaviour, use | ||
| 1427 | 1428 | :meth:`HEAD.reset <git.refs.head.HEAD.reset>` instead. | |
| 1428 | 1429 | ||
| 1429 | 1430 | :return: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -130,8 +130,7 @@ def stage(self) -> int: | |||
| 130 | 130 | * 3 = stage of entries from the 'right' side of the merge | |
| 131 | 131 | ||
| 132 | 132 | :note: | |
| 133 | - For more information, see: | ||
| 134 | - http://www.kernel.org/pub/software/scm/git/docs/git-read-tree.html | ||
| 133 | + For more information, see :manpage:`git-read-tree(1)`. | ||
| 135 | 134 | """ | |
| 136 | 135 | return (self.flags & CE_STAGEMASK) >> CE_STAGESHIFT | |
| 137 | 136 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -45,7 +45,7 @@ class Object(LazyMixin): | |||
| 45 | 45 | * :class:`Commit <git.objects.commit.Commit>` | |
| 46 | 46 | * :class:`TagObject <git.objects.tag.TagObject>` | |
| 47 | 47 | ||
| 48 | - See gitglossary(7) on: | ||
| 48 | + See :manpage:`gitglossary(7)` on: | ||
| 49 | 49 | ||
| 50 | 50 | * "object": https://git-scm.com/docs/gitglossary#def_object | |
| 51 | 51 | * "object type": https://git-scm.com/docs/gitglossary#def_object_type | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -19,7 +19,8 @@ | |||
| 19 | 19 | class Blob(base.IndexObject): | |
| 20 | 20 | """A Blob encapsulates a git blob object. | |
| 21 | 21 | ||
| 22 | - See gitglossary(7) on "blob": https://git-scm.com/docs/gitglossary#def_blob_object | ||
| 22 | + See :manpage:`gitglossary(7)` on "blob": | ||
| 23 | + https://git-scm.com/docs/gitglossary#def_blob_object | ||
| 23 | 24 | """ | |
| 24 | 25 | ||
| 25 | 26 | DEFAULT_MIME_TYPE = "text/plain" | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -65,7 +65,7 @@ | |||
| 65 | 65 | class Commit(base.Object, TraversableIterableObj, Diffable, Serializable): | |
| 66 | 66 | """Wraps a git commit object. | |
| 67 | 67 | ||
| 68 | - See gitglossary(7) on "commit object": | ||
| 68 | + See :manpage:`gitglossary(7)` on "commit object": | ||
| 69 | 69 | https://git-scm.com/docs/gitglossary#def_commit_object | |
| 70 | 70 | ||
| 71 | 71 | :note: | |
@@ -269,8 +269,9 @@ def count(self, paths: Union[PathLike, Sequence[PathLike]] = "", **kwargs: Any) | |||
| 269 | 269 | actually containing the paths. | |
| 270 | 270 | ||
| 271 | 271 | :param kwargs: | |
| 272 | - Additional options to be passed to ``git rev-list``. They must not alter the | ||
| 273 | - output style of the command, or parsing will yield incorrect results. | ||
| 272 | + Additional options to be passed to :manpage:`git-rev-list(1)`. They must not | ||
| 273 | + alter the output style of the command, or parsing will yield incorrect | ||
| 274 | + results. | ||
| 274 | 275 | ||
| 275 | 276 | :return: | |
| 276 | 277 | An int defining the number of reachable commits | |
@@ -307,14 +308,14 @@ def iter_items( | |||
| 307 | 308 | The :class:`~git.repo.base.Repo`. | |
| 308 | 309 | ||
| 309 | 310 | :param rev: | |
| 310 | - Revision specifier. See git-rev-parse for viable options. | ||
| 311 | + Revision specifier. See :manpage:`git-rev-parse(1)` for viable options. | ||
| 311 | 312 | ||
| 312 | 313 | :param paths: | |
| 313 | 314 | An optional path or list of paths. If set only :class:`Commit`\s that | |
| 314 | 315 | include the path or paths will be considered. | |
| 315 | 316 | ||
| 316 | 317 | :param kwargs: | |
| 317 | - Optional keyword arguments to ``git rev-list`` where: | ||
| 318 | + Optional keyword arguments to :manpage:`git-rev-list(1)` where: | ||
| 318 | 319 | ||
| 319 | 320 | * ``max_count`` is the maximum number of commits to fetch. | |
| 320 | 321 | * ``skip`` is the number of commits to skip. | |
@@ -353,7 +354,7 @@ def iter_parents(self, paths: Union[PathLike, Sequence[PathLike]] = "", **kwargs | |||
| 353 | 354 | contain at least one of the paths. | |
| 354 | 355 | ||
| 355 | 356 | :param kwargs: | |
| 356 | - All arguments allowed by ``git rev-list``. | ||
| 357 | + All arguments allowed by :manpage:`git-rev-list(1)`. | ||
| 357 | 358 | ||
| 358 | 359 | :return: | |
| 359 | 360 | Iterator yielding :class:`Commit` objects which are parents of ``self`` | |
@@ -404,7 +405,7 @@ def trailers_list(self) -> List[Tuple[str, str]]: | |||
| 404 | 405 | """Get the trailers of the message as a list. | |
| 405 | 406 | ||
| 406 | 407 | Git messages can contain trailer information that are similar to RFC 822 e-mail | |
| 407 | - headers (see: https://git-scm.com/docs/git-interpret-trailers). | ||
| 408 | + headers. See :manpage:`git-interpret-trailers(1)`. | ||
| 408 | 409 | ||
| 409 | 410 | This function calls ``git interpret-trailers --parse`` onto the message to | |
| 410 | 411 | extract the trailer information, returns the raw trailer data as a list. | |
@@ -456,7 +457,7 @@ def trailers_dict(self) -> Dict[str, List[str]]: | |||
| 456 | 457 | """Get the trailers of the message as a dictionary. | |
| 457 | 458 | ||
| 458 | 459 | Git messages can contain trailer information that are similar to RFC 822 e-mail | |
| 459 | - headers (see: https://git-scm.com/docs/git-interpret-trailers). | ||
| 460 | + headers. See :manpage:`git-interpret-trailers(1)`. | ||
| 460 | 461 | ||
| 461 | 462 | This function calls ``git interpret-trailers --parse`` onto the message to | |
| 462 | 463 | extract the trailer information. The key value pairs are stripped of leading and | |
@@ -499,7 +500,7 @@ def _iter_from_process_or_stream(cls, repo: "Repo", proc_or_stream: Union[Popen, | |||
| 499 | 500 | from our lighting fast object database. | |
| 500 | 501 | ||
| 501 | 502 | :param proc: | |
| 502 | - ``git rev-list`` process instance - one sha per line. | ||
| 503 | + :manpage:`git-rev-list(1)` process instance - one sha per line. | ||
| 503 | 504 | ||
| 504 | 505 | :return: | |
| 505 | 506 | Iterator supplying :class:`Commit` objects | |
@@ -596,8 +597,8 @@ def create_from_tree( | |||
| 596 | 597 | ||
| 597 | 598 | :note: | |
| 598 | 599 | Additional information about the committer and author are taken from the | |
| 599 | - environment or from the git configuration. See git-commit-tree for more | ||
| 600 | - information. | ||
| 600 | + environment or from the git configuration. See :manpage:`git-commit-tree(1)` | ||
| 601 | + for more information. | ||
| 601 | 602 | """ | |
| 602 | 603 | if parent_commits is None: | |
| 603 | 604 | try: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -342,7 +342,7 @@ def _clone_repo( | |||
| 342 | 342 | Allow unsafe options to be used, like ``--upload-pack``. | |
| 343 | 343 | ||
| 344 | 344 | :param kwargs: | |
| 345 | - Additional arguments given to ``git clone``. | ||
| 345 | + Additional arguments given to :manpage:`git-clone(1)`. | ||
| 346 | 346 | """ | |
| 347 | 347 | module_abspath = cls._module_abspath(repo, path, name) | |
| 348 | 348 | module_checkout_path = module_abspath | |
@@ -463,10 +463,10 @@ def add( | |||
| 463 | 463 | It will be created as required during the repository initialization. | |
| 464 | 464 | ||
| 465 | 465 | :param url: | |
| 466 | - git-clone compatible URL, see git-clone reference for more information. | ||
| 467 | - If ``None``, the repository is assumed to exist, and the url of the first | ||
| 468 | - remote is taken instead. This is useful if you want to make an existing | ||
| 469 | - repository a submodule of another one. | ||
| 466 | + ``git clone ...``-compatible URL. See :manpage:`git-clone(1)` for more | ||
| 467 | + information. If ``None``, the repository is assumed to exist, and the URL of | ||
| 468 | + the first remote is taken instead. This is useful if you want to make an | ||
| 469 | + existing repository a submodule of another one. | ||
| 470 | 470 | ||
| 471 | 471 | :param branch: | |
| 472 | 472 | Name of branch at which the submodule should (later) be checked out. The | |
@@ -696,7 +696,7 @@ def update( | |||
| 696 | 696 | its value. | |
| 697 | 697 | ||
| 698 | 698 | :param clone_multi_options: | |
| 699 | - List of ``git clone`` options. | ||
| 699 | + List of :manpage:`git-clone(1)` options. | ||
| 700 | 700 | Please see :meth:`Repo.clone <git.repo.base.Repo.clone>` for details. | |
| 701 | 701 | They only take effect with the `init` option. | |
| 702 | 702 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -37,7 +37,7 @@ class TagObject(base.Object): | |||
| 37 | 37 | """Annotated (i.e. non-lightweight) tag carrying additional information about an | |
| 38 | 38 | object we are pointing to. | |
| 39 | 39 | ||
| 40 | - See gitglossary(7) on "tag object": | ||
| 40 | + See :manpage:`gitglossary(7)` on "tag object": | ||
| 41 | 41 | https://git-scm.com/docs/gitglossary#def_tag_object | |
| 42 | 42 | """ | |
| 43 | 43 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments