Add documentation on configuring specific types of repositories.

Review Request #8537 — Created Nov. 14, 2016 and submitted

Information

Review Board
release-2.5.x
046412f...

Reviewers

This adds documentation on configuring Bazaar, ClearCase, CVS, Git,
Mercurial, Perforce, and Subversion repositories. It goes into the
various setup options for each type and provides a complete walkthrough
on how to get set up, from installing dependencies to configuring fields
to the various authentication and conncetion options (where appropriate).
This replaces the old and very basic documentation we had before.

These docs do not cover setting up hosting services yet. That will be
done separately.

Built the docs and read through. Checked links and setup instructions
for accuracy.

Description From Last Updated

This is kind of an abrupt transition. Can we add some more info about what the limited remote protocol means …

daviddavid

Should be "Perforce"

daviddavid

Fix wrapping?

daviddavid

Too many spaces between sentences.

daviddavid

Fix wrapping?

daviddavid

Should be Subversion, not Git.

gmyersgmyers

typo: requess

daviddavid

requess

daviddavid

requess

daviddavid

requess

daviddavid

requess

daviddavid

I think we should probably list these at the top rather than the bottom. I think it's likely that someone …

daviddavid

These should probably be listed near the top rather than the bottom.

daviddavid

Should mention these near the top.

daviddavid
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
  2. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
  2. 
      
gmyers
  1. 
      
  2. Show all issues
    Should be Subversion, not Git.
  3. 
      
david
  1. 
      
  2. docs/manual/admin/configuration/repositories/git.rst (Diff revision 2)
     
     
     
     
     
     
     
     
     
    Show all issues

    This is kind of an abrupt transition. Can we add some more info about what the limited remote protocol means for users (i.e. that they'll have to set up some kind of frontend server or use a local path)?

  3. Show all issues

    Should be "Perforce"

  4. Show all issues

    Fix wrapping?

  5. Show all issues

    Too many spaces between sentences.

    1. Thanks for catching these. This is always an artifact of wrapping. I need to figure out how to get vim to collapse the extra spaces when I do this.

    2. set nojoinspaces
      set tw=79
      

      And then to rewrap the current paragraph, "gqap"

  6. Show all issues

    Fix wrapping?

  7. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
  2. 
      
david
  1. 
      
  2. Show all issues

    typo: requess

  3. Show all issues

    requess

  4. Show all issues

    requess

  5. Show all issues

    requess

  6. Show all issues

    requess

  7. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
  2. 
      
david
  1. 
      
  2. docs/manual/admin/configuration/repositories/git.rst (Diff revision 4)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
    Show all issues

    I think we should probably list these at the top rather than the bottom. I think it's likely that someone who has a git repository hosted on GitHub might end up here, and get confused/annoyed at the instructions for GitWeb, etc.

    1. We have a big in-your-face note block calling this out, but I can play with this a bit.

  3. docs/manual/admin/configuration/repositories/mercurial.rst (Diff revision 4)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
    Show all issues

    These should probably be listed near the top rather than the bottom.

  4. docs/manual/admin/configuration/repositories/subversion.rst (Diff revision 4)
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
    Show all issues

    Should mention these near the top.

  5. 
      
chipx86
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        docs/manual/conf.py
    
    Ignored Files:
        docs/manual/admin/configuration/index.rst
        docs/manual/admin/configuration/repositories/mercurial.rst
        docs/manual/admin/configuration/repositories/git.rst
        docs/manual/admin/configuration/repositories/index.rst
        docs/manual/admin/configuration/repositories/subversion.rst
        docs/manual/admin/index.rst
        docs/manual/admin/installation/linux.rst
        docs/manual/admin/configuration/repositories/bazaar.rst
        docs/manual/users/review-requests/creating.rst
        docs/manual/admin/configuration/repositories/clearcase.rst
        docs/manual/admin/configuration/repositories/perforce.rst
        docs/manual/admin/configuration/repositories/cvs.rst
    
    
  2. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to release-2.5.x (1a894a1)