Wizard
Software Engineering Project - Wizard
Loading...
Searching...
No Matches
release_docs Namespace Reference

Classes

class  WikiBrancher
 

Functions

 DropWikiSuffix (wiki_filename)
 
 main ()
 

Variables

list GTEST_UNVERSIONED_WIKIS = ['DevGuide.wiki']
 
list GMOCK_UNVERSIONED_WIKIS
 

Detailed Description

Script for branching Google Test/Mock wiki pages for a new version.

SYNOPSIS
       release_docs.py NEW_RELEASE_VERSION

       Google Test and Google Mock's external user documentation is in
       interlinked wiki files.  When we release a new version of
       Google Test or Google Mock, we need to branch the wiki files
       such that users of a specific version of Google Test/Mock can
       look up documenation relevant for that version.  This script
       automates that process by:

         - branching the current wiki pages (which document the
           behavior of the SVN trunk head) to pages for the specified
           version (e.g. branching FAQ.wiki to V2_6_FAQ.wiki when
           NEW_RELEASE_VERSION is 2.6);
         - updating the links in the branched files to point to the branched
           version (e.g. a link in V2_6_FAQ.wiki that pointed to
           Primer.wiki#Anchor will now point to V2_6_Primer.wiki#Anchor).

       NOTE: NEW_RELEASE_VERSION must be a NEW version number for
       which the wiki pages don't yet exist; otherwise you'll get SVN
       errors like "svn: Path 'V1_7_PumpManual.wiki' is not a
       directory" when running the script.

EXAMPLE
       $ cd PATH/TO/GTEST_SVN_WORKSPACE/trunk
       $ scripts/release_docs.py 2.6  # create wiki pages for v2.6
       $ svn status                   # verify the file list
       $ svn diff                     # verify the file contents
       $ svn commit -m "release wiki pages for v2.6"

Function Documentation

◆ DropWikiSuffix()

release_docs.DropWikiSuffix ( wiki_filename)
Removes the .wiki suffix (if any) from the given filename.

Variable Documentation

◆ GMOCK_UNVERSIONED_WIKIS

list release_docs.GMOCK_UNVERSIONED_WIKIS
Initial value:
1= [
2 'DesignDoc.wiki',
3 'DevGuide.wiki',
4 'KnownIssues.wiki'
5 ]