Commits

Mike Fogel committed 0a4c268

documentation for -a <project_path> flag

Comments (0)

Files changed (2)

docs/en/command_ref.rst

 
 Syntax::
 
-    mkvirtualenv [-i package] [-r requirements_file] [virtualenv options] ENVNAME
+    mkvirtualenv [-a project_path] [-i package] [-r requirements_file] [virtualenv options] ENVNAME
 
-All command line options except ``-i``, ``-r``, and ``-h`` are passed
+All command line options except ``-a``, ``-i``, ``-r``, and ``-h`` are passed
 directly to ``virtualenv``.  The new environment is automatically
 activated after being initialized.
 
     mynewenv
     (mynewenv)$ 
 
+The ``-a`` option can be used to associate a project with the new environment.
+
 The ``-i`` option can be used to install one or more packages (by
 repeating the option) after the environment is created.
 

docs/en/scripts.rst

   :Sourced/Run: sourced
 
 ``$VIRTUALENVWRAPPER_HOOK_DIR/postmkvirtualenv`` is sourced after the new environment
-is created and activated.
+is created and activated. If the ``-a`` <project_path> flag was used,
+the link to the project directory is set up before this script is sourced.
 
 .. _scripts-precpvirtualenv: