From 5e98b44e123f29460974914471f436336f010157 Mon Sep 17 00:00:00 2001
From: "R. David Murray" <rdmurray@bitdance.com>
Date: Thu, 9 Feb 2017 15:01:38 -0500
Subject: [PATCH] Explain how -e affects pip freeze.

---
 docs/reference/pip_install.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/reference/pip_install.rst b/docs/reference/pip_install.rst
index fbc42bece..733e0bb02 100644
--- a/docs/reference/pip_install.rst
+++ b/docs/reference/pip_install.rst
@@ -325,6 +325,9 @@ the :ref:`--editable <install_--editable>` option) or not.
   already installed, the VCS source will not overwrite it without an `--upgrade`
   flag. VCS requirements pin the package version (specified in the `setup.py`
   file) of the target commit, not necessarily the commit itself.
+* The :ref:`pip freeze` subcomand will record the VCS requirement specifier
+  (referencing a specific commit) if and only if the install is done using the
+  editable option.
 
 The "project name" component of the url suffix "egg=<project name>-<version>"
 is used by pip in its dependency logic to identify the project prior