Merge pull request #30 from jebpublic/releaseVer1_3_4

Update to version 1.3.4

docs/source/conf.py

@@ -57,9 +57,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.3.3'
+version = '1.3.4'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.3'
+release = '1.3.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

howToReleaseNewVersion.txt

@@ -1,24 +1,7 @@
 When you are ready to release a new version of pybvc then follow these steps.
 
-COPY FROM DEVELOPMENT REPOSITORY:
----------------------------------
-1.  Update the development repository (git pull in elbrys/pydevodl)
-2.  Update the release repository (git pull in brcd/pybvc)
-3.5 Copy pybvc/__init__.py to someplace safe
-3.  Remove contents of the pybvc folder in release repository (everything but __init__.py)
-4.  Copy the framework folder contents from development to release:
-        cp -r elbrys/pydevodl/framework/* brcd/pybvc
-              NOTE the paths will need to be changed to match your setup
-4.5 Copy __init__.py from step 3.5 back
-5.  In the brcd/pybvc folder do a global search and replace:  find 'pybvc.' and replace with 'pybvc.'
-6.  Run the copyright check perl script as follows and verify that no source files show error (missing copyright):
-        cd pybvc
-        perl b00-copyright.t
-
-
 UPDATE VERSION:
 ---------------
-In master branch of brcdcom/pybvc
 1.  Update VERSION in the file pybvc/__init__.py
     - X.Y.Z
 	- Increment Z when you fix something
@@ -31,6 +14,7 @@ PUSH TO GITHUB:
 git add .
 git commit -m "Update to version <version>"
 git push
+go to github/<your repository> and do a pull request
 
 UPDATE DOCS:
 ------------
@@ -52,7 +36,6 @@ Describe Release:  bullet list of major changes.  Example markdown:
 
 UPDATE PyPi
 -----------
-In master branch:
 In the file pybvc/__init.py__ make sure it has the contents:
 __title__ = 'pybvc'
 __version__ = '1.2.0'

howToUpdateDocs.txt

@@ -1,17 +1,23 @@
 The documentation for pybvc is autogenerated and hosted on Github.  This document describes how to update the docs on Github.
 1.  You need to have Sphinx installed.  This is the tool that autogenerates the documentation from the comments in the Python code.
-2.  You need to have both the master and gh-pages branches for pybvc:
-       git checkout -b gh-pages orgin/gh-pages
+2.  You need to have both a branch-of the master branch and a branch-of the gh-pages branch:
+       - git checkout master
+       - git pull --rebase upstream master
+       - git checkout -b master-docs
+       - git checkout gh-pages
+       - git pull --rebase upstream gh-pages
+       - git checkout -b gh-pages-docs
 2.  You need to have written comments (in Sphinx format) in the Python source code.
-3.  You need to be in the 'master' branch (git checkout master)
+3.  You need to be in the 'master-docs' branch 
+       - git checkout master-docs
 4.  You need to be at the top directory (it should contain dodoc and publishdoc scripts)
 5.  Run:   ./dodoc
     This will run Sphinx and generate new documentation from the comments in the code.  It may ask you if you want to
     replace files in docsForGhPagesBranch, indicate you want to replace (A)ll.
 5.  Run:   ./publishdoc
-    This will move the generated html documentation files from the master branch to the 'gh-pages' branch
-    The gh-pages branch is special in Github and it will generate a web page from the contents of this branch.
-    When the script is done you will be left in the gh-pages branch.  Do not move out of the branch yet.
+    This will move the generated html documentation files from the master-docs branch to the 'gh-pages-docs' branch
+    The gh-pages-docs branch is special in Github and it will generate a web page from the contents of this branch.
+    When the script is done you will be left in the gh-pages-docs branch.  Do not move out of the branch yet.
 6.  Run:  git add .
     This will add all the new html doc pages for staging
 7.  Run:  git commit
@@ -21,7 +27,10 @@ The documentation for pybvc is autogenerated and hosted on Github.  This documen
     This will push the new html doc pages to the gh-pages branch
 9.  Run:  git checkout master
     This will return you to the master branch
-10. Check out the new documents (wait about 3 minutes for Github to prep them) at:  http://brcdcomm.github.io/pybvc/index.html
+10. Go to github.com/<your repository> and create a pull request for your changes to gh-pages
+      BE SURE THAT THE PULL REQUEST IS GOING FROM your gh-pages-docs branch to brcdcomm/pybvc's gh-pages branch!!!!
+      THAT IS VERY VERY IMPORTANT - you DO NOT WANT to send your gh-pages-docs changes to the master branch by accident.
+10. After your pull request is accepted:  Check out the new documents (wait about 3 minutes for Github to prep them) at:  http://brcdcomm.github.io/pybvc/index.html
 11. If something is wrong with the web pages you can debug them using the Google Chrome developer tools (or your browsers equivalent)
 
 Background:

pybvc/__init__.py

@@ -1,5 +1,5 @@
 __title__ = 'pybvc'
-__version__ = '1.3.3'
+__version__ = '1.3.4'
 __author__ = 'Sergei Garbuzov'
 __license__ = 'BSD'
 __copyright__ = 'Brocade Communications'