Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update USE_SHELL docstring on why not to use it anymore
This expands the "docstring" associated with the Git.USE_SHELL attribute to mention the dangers of setting it to True and explain the old purpose it once served for graphical Windows applications and why it is no longer required for that since 2.0.8. (See #1781.) Although setting `Git.USE_SHELL = True` or passing `shell=True` should rarely if ever be done and is no longer necessary even in the specific scenario for which it was once recommended, I have deliberately avoided claiming USE_SHELL is deprecated at this time. Whether GitPython should formally deprecate it (documenting it as such and issuing DeprecationWarning on some or all uses) may hinge on whether it is possible for GitPython to incorporate enhancements that account for and suppress at least some unintended shell expansions when shell=True is passed through dynamic methods that indirectly call Git.execute. The decision may also benefit from examination of existing common uses, if any, of `USE_SHELL = True`.
- Loading branch information