| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 9b68361 commit 30387f1
7 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | # | |
| 3 | 3 | ||
| 4 | 4 | # You can set these variables from the command line. | |
| 5 | - SPHINXOPTS = | ||
| 5 | + SPHINXOPTS = -W | ||
| 6 | 6 | SPHINXBUILD = sphinx-build | |
| 7 | 7 | PAPER = | |
| 8 | 8 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -139,9 +139,9 @@ https://github.com/gitpython-developers/gitpython/milestone/30?closed=1 | |||
| 139 | 139 | 3.0.1 - Bugfixes and performance improvements | |
| 140 | 140 | ============================================= | |
| 141 | 141 | ||
| 142 | - * Fix a `performance regression <https://github.com/gitpython-developers/GitPython/issues/906>`_ which could make certain workloads 50% slower | ||
| 143 | - * Add `currently_rebasing_on` method on `Repo`, see `the PR <https://github.com/gitpython-developers/GitPython/pull/903/files#diff-c276fc3c4df38382ec884e59657b869dR1065>`_ | ||
| 144 | - * Fix incorrect `requirements.txt` which could lead to broken installations, see this `issue <https://github.com/gitpython-developers/GitPython/issues/908>`_ for details. | ||
| 142 | + * Fix a `performance regression <https://github.com/gitpython-developers/GitPython/issues/906>`__ which could make certain workloads 50% slower | ||
| 143 | + * Add `currently_rebasing_on` method on `Repo`, see `the PR <https://github.com/gitpython-developers/GitPython/pull/903/files#diff-c276fc3c4df38382ec884e59657b869dR1065>`__ | ||
| 144 | + * Fix incorrect `requirements.txt` which could lead to broken installations, see this `issue <https://github.com/gitpython-developers/GitPython/issues/908>`__ for details. | ||
| 145 | 145 | ||
| 146 | 146 | 3.0.0 - Remove Python 2 support | |
| 147 | 147 | =============================== | |
@@ -276,6 +276,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone | |||
| 276 | 276 | the `HEAD` reference instead. | |
| 277 | 277 | ||
| 278 | 278 | * `DiffIndex.iter_change_type(...)` produces better results when diffing | |
| 279 | + | ||
| 279 | 280 | 2.0.8 - Features and Bugfixes | |
| 280 | 281 | ============================= | |
| 281 | 282 | ||
@@ -304,7 +305,7 @@ https://github.com/gitpython-developers/GitPython/issues?q=is%3Aclosed+milestone | |||
| 304 | 305 | unicode path counterparts. | |
| 305 | 306 | * Fix: TypeError about passing keyword argument to string decode() on | |
| 306 | 307 | Python 2.6. | |
| 307 | - * Feature: `setUrl API on Remotes <https://github.com/gitpython-developers/GitPython/pull/446#issuecomment-224670539>`_ | ||
| 308 | + * Feature: `setUrl API on Remotes <https://github.com/gitpython-developers/GitPython/pull/446#issuecomment-224670539>`__ | ||
| 308 | 309 | ||
| 309 | 310 | 2.0.5 - Fixes | |
| 310 | 311 | ============= | |
@@ -380,13 +381,13 @@ Please note that due to breaking changes, we have to increase the major version. | |||
| 380 | 381 | with large repositories. | |
| 381 | 382 | * CRITICAL: fixed incorrect `Commit` object serialization when authored or commit date had timezones which were not | |
| 382 | 383 | divisiblej by 3600 seconds. This would happen if the timezone was something like `+0530` for instance. | |
| 383 | - * A list of all additional fixes can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.2+-+Fixes%22+is%3Aclosed>`_ | ||
| 384 | + * A list of all additional fixes can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.2+-+Fixes%22+is%3Aclosed>`__ | ||
| 384 | 385 | * CRITICAL: `Tree.cache` was removed without replacement. It is technically impossible to change individual trees and expect their serialization results to be consistent with what *git* expects. Instead, use the `IndexFile` facilities to adjust the content of the staging area, and write it out to the respective tree objects using `IndexFile.write_tree()` instead. | |
| 385 | 386 | ||
| 386 | 387 | 1.0.1 - Fixes | |
| 387 | 388 | ============= | |
| 388 | 389 | ||
| 389 | - * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.1+-+Fixes%22+is%3Aclosed>`_ | ||
| 390 | + * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v1.0.1+-+Fixes%22+is%3Aclosed>`__ | ||
| 390 | 391 | ||
| 391 | 392 | 1.0.0 - Notes | |
| 392 | 393 | ============= | |
@@ -403,14 +404,14 @@ It follows the `semantic version scheme <http://semver.org>`_, and thus will not | |||
| 403 | 404 | * If the git command executed during `Remote.push(...)|fetch(...)` returns with an non-zero exit code and GitPython didn't | |
| 404 | 405 | obtain any head-information, the corresponding `GitCommandError` will be raised. This may break previous code which expected | |
| 405 | 406 | these operations to never raise. However, that behavious is undesirable as it would effectively hide the fact that there | |
| 406 | - was an error. See `this issue <https://github.com/gitpython-developers/GitPython/issues/271>`_ for more information. | ||
| 407 | + was an error. See `this issue <https://github.com/gitpython-developers/GitPython/issues/271>`__ for more information. | ||
| 407 | 408 | ||
| 408 | 409 | * If the git executable can't be found in the PATH or at the path provided by `GIT_PYTHON_GIT_EXECUTABLE`, this is made | |
| 409 | 410 | obvious by throwing `GitCommandNotFound`, both on unix and on windows. | |
| 410 | 411 | ||
| 411 | 412 | - Those who support **GUI on windows** will now have to set `git.Git.USE_SHELL = True` to get the previous behaviour. | |
| 412 | 413 | ||
| 413 | - * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.7+-+Fixes%22+is%3Aclosed>`_ | ||
| 414 | + * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.7+-+Fixes%22+is%3Aclosed>`__ | ||
| 414 | 415 | ||
| 415 | 416 | ||
| 416 | 417 | 0.3.6 - Features | |
@@ -426,11 +427,11 @@ It follows the `semantic version scheme <http://semver.org>`_, and thus will not | |||
| 426 | 427 | * Repo.working_tree_dir now returns None if it is bare. Previously it raised AssertionError. | |
| 427 | 428 | * IndexFile.add() previously raised AssertionError when paths where used with bare repository, now it raises InvalidGitRepositoryError | |
| 428 | 429 | ||
| 429 | - * Added `Repo.merge_base()` implementation. See the `respective issue on GitHub <https://github.com/gitpython-developers/GitPython/issues/169>`_ | ||
| 430 | + * Added `Repo.merge_base()` implementation. See the `respective issue on GitHub <https://github.com/gitpython-developers/GitPython/issues/169>`__ | ||
| 430 | 431 | * `[include]` sections in git configuration files are now respected | |
| 431 | 432 | * Added `GitConfigParser.rename_section()` | |
| 432 | 433 | * Added `Submodule.rename()` | |
| 433 | - * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+>`_ | ||
| 434 | + * A list of all issues can be found `on GitHub <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+>`__ | ||
| 434 | 435 | ||
| 435 | 436 | 0.3.5 - Bugfixes | |
| 436 | 437 | ================ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -219,7 +219,7 @@ def merge_tree(self, rhs, base=None): | |||
| 219 | 219 | """Merge the given rhs treeish into the current index, possibly taking | |
| 220 | 220 | a common base treeish into account. | |
| 221 | 221 | ||
| 222 | - As opposed to the from_tree_ method, this allows you to use an already | ||
| 222 | + As opposed to the :func:`IndexFile.from_tree` method, this allows you to use an already | ||
| 223 | 223 | existing tree as the left side of the merge | |
| 224 | 224 | ||
| 225 | 225 | :param rhs: | |
@@ -830,7 +830,7 @@ def remove(self, items, working_tree=False, **kwargs): | |||
| 830 | 830 | to a path relative to the git repository directory containing | |
| 831 | 831 | the working tree | |
| 832 | 832 | ||
| 833 | - The path string may include globs, such as *.c. | ||
| 833 | + The path string may include globs, such as \\*.c. | ||
| 834 | 834 | ||
| 835 | 835 | - Blob Object | |
| 836 | 836 | Only the path portion is used in this case. | |
@@ -998,7 +998,7 @@ def checkout(self, paths=None, force=False, fprogress=lambda *args: None, **kwar | |||
| 998 | 998 | If False, these will trigger a CheckoutError. | |
| 999 | 999 | ||
| 1000 | 1000 | :param fprogress: | |
| 1001 | - see Index.add_ for signature and explanation. | ||
| 1001 | + see :func:`IndexFile.add` for signature and explanation. | ||
| 1002 | 1002 | The provided progress information will contain None as path and item if no | |
| 1003 | 1003 | explicit paths are given. Otherwise progress information will be send | |
| 1004 | 1004 | prior and after a file has been checked out | |
@@ -1010,7 +1010,7 @@ def checkout(self, paths=None, force=False, fprogress=lambda *args: None, **kwar | |||
| 1010 | 1010 | iterable yielding paths to files which have been checked out and are | |
| 1011 | 1011 | guaranteed to match the version stored in the index | |
| 1012 | 1012 | ||
| 1013 | - :raise CheckoutError: | ||
| 1013 | + :raise exc.CheckoutError: | ||
| 1014 | 1014 | If at least one file failed to be checked out. This is a summary, | |
| 1015 | 1015 | hence it will checkout as many files as it can anyway. | |
| 1016 | 1016 | If one of files or directories do not exist in the index | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -965,7 +965,7 @@ def set_parent_commit(self, commit, check=True): | |||
| 965 | 965 | @unbare_repo | |
| 966 | 966 | def config_writer(self, index=None, write=True): | |
| 967 | 967 | """:return: a config writer instance allowing you to read and write the data | |
| 968 | - belonging to this submodule into the .gitmodules file. | ||
| 968 | + belonging to this submodule into the .gitmodules file. | ||
| 969 | 969 | ||
| 970 | 970 | :param index: if not None, an IndexFile instance which should be written. | |
| 971 | 971 | defaults to the index of the Submodule's parent repository. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -827,10 +827,8 @@ def push(self, refspec=None, progress=None, **kwargs): | |||
| 827 | 827 | ||
| 828 | 828 | * None to discard progress information | |
| 829 | 829 | * A function (callable) that is called with the progress information. | |
| 830 | - | ||
| 831 | 830 | Signature: ``progress(op_code, cur_count, max_count=None, message='')``. | |
| 832 | - | ||
| 833 | - `Click here <http://goo.gl/NPa7st>`_ for a description of all arguments | ||
| 831 | + `Click here <http://goo.gl/NPa7st>`__ for a description of all arguments | ||
| 834 | 832 | given to the function. | |
| 835 | 833 | * An instance of a class derived from ``git.RemoteProgress`` that | |
| 836 | 834 | overrides the ``update()`` function. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -270,9 +270,9 @@ def working_tree_dir(self): | |||
| 270 | 270 | ||
| 271 | 271 | @property | |
| 272 | 272 | def common_dir(self): | |
| 273 | - """:return: The git dir that holds everything except possibly HEAD, | ||
| 274 | - FETCH_HEAD, ORIG_HEAD, COMMIT_EDITMSG, index, and logs/ . | ||
| 275 | 273 | """ | |
| 274 | + :return: The git dir that holds everything except possibly HEAD, | ||
| 275 | + FETCH_HEAD, ORIG_HEAD, COMMIT_EDITMSG, index, and logs/.""" | ||
| 276 | 276 | return self._common_dir or self.git_dir | |
| 277 | 277 | ||
| 278 | 278 | @property | |
@@ -988,7 +988,7 @@ def clone(self, path, progress=None, multi_options=None, **kwargs): | |||
| 988 | 988 | :param multi_options: A list of Clone options that can be provided multiple times. One | |
| 989 | 989 | option per list item which is passed exactly as specified to clone. | |
| 990 | 990 | For example ['--config core.filemode=false', '--config core.ignorecase', | |
| 991 | - '--recurse-submodule=repo1_path', '--recurse-submodule=repo2_path'] | ||
| 991 | + '--recurse-submodule=repo1_path', '--recurse-submodule=repo2_path'] | ||
| 992 | 992 | :param kwargs: | |
| 993 | 993 | * odbt = ObjectDatabase Type, allowing to determine the object database | |
| 994 | 994 | implementation used by the returned Repo instance | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -39,11 +39,11 @@ | |||
| 39 | 39 | # Handle once test-cases are back up and running. | |
| 40 | 40 | # Most of these are unused here, but are for use by git-python modules so these | |
| 41 | 41 | # don't see gitdb all the time. Flake of course doesn't like it. | |
| 42 | - __all__ = ("stream_copy", "join_path", "to_native_path_windows", "to_native_path_linux", | ||
| 42 | + __all__ = ["stream_copy", "join_path", "to_native_path_linux", | ||
| 43 | 43 | "join_path_native", "Stats", "IndexFileSHA1Writer", "Iterable", "IterableList", | |
| 44 | 44 | "BlockingLockFile", "LockFile", 'Actor', 'get_user_id', 'assure_directory_exists', | |
| 45 | 45 | 'RemoteProgress', 'CallableRemoteProgress', 'rmtree', 'unbare_repo', | |
| 46 | - 'HIDE_WINDOWS_KNOWN_ERRORS') | ||
| 46 | + 'HIDE_WINDOWS_KNOWN_ERRORS'] | ||
| 47 | 47 | ||
| 48 | 48 | log = logging.getLogger(__name__) | |
| 49 | 49 | ||
@@ -148,6 +148,7 @@ def to_native_path_windows(path): | |||
| 148 | 148 | def to_native_path_linux(path): | |
| 149 | 149 | return path.replace('\\', '/') | |
| 150 | 150 | ||
| 151 | + __all__.append("to_native_path_windows") | ||
| 151 | 152 | to_native_path = to_native_path_windows | |
| 152 | 153 | else: | |
| 153 | 154 | # no need for any work on linux | |
| Back | FazBrowse Home | New Git URL |
0 commit comments