From b6aab6d9d6aec26fcf32c45c00f789dc2d2d1ab6 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 1 Dec 2014 14:34:28 -0500 Subject: [PATCH] Split README.rst into separate doc files Split up the README into separate documentation files so we can publish the documentation for git-review. Change-Id: Idcdf43e73c5ca5b8cb239606236e3b2a660c46b7 --- .gitignore | 1 + CONTRIBUTING.rst | 22 ++++ README.rst | 171 +----------------------- doc/Makefile | 177 +++++++++++++++++++++++++ doc/source/conf.py | 252 ++++++++++++++++++++++++++++++++++++ doc/source/developing.rst | 23 ++++ doc/source/index.rst | 22 ++++ doc/source/installation.rst | 85 ++++++++++++ doc/source/usage.rst | 47 +++++++ setup.cfg | 8 ++ test-requirements.txt | 2 + tox.ini | 4 + 12 files changed, 647 insertions(+), 167 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/Makefile create mode 100644 doc/source/conf.py create mode 100644 doc/source/developing.rst create mode 100644 doc/source/index.rst create mode 100644 doc/source/installation.rst create mode 100644 doc/source/usage.rst diff --git a/.gitignore b/.gitignore index 3ecaa71e..8446bf15 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ ChangeLog *.egg *.egg-info *.pyc +doc/build diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..333d221a --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,22 @@ +============================ + Contributing to git-review +============================ + +To get the latest code, see: https://git.openstack.org/cgit/openstack-infra/git-review + +Bugs are handled at: https://storyboard.openstack.org/#!/project/719 + +There is a mailing list at: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-infra + +Code reviews, as you might expect, are handled by gerrit at: +https://review.openstack.org + +See http://wiki.openstack.org/GerritWorkflow for details. Pull +requests submitted through GitHub will be ignored. + +Use ``git review`` to submit patches (after creating a gerrit account +that links to your launchpad account). Example:: + + # Do your commits + git review + # Enter your username if prompted diff --git a/README.rst b/README.rst index 36541d54..5d60a295 100644 --- a/README.rst +++ b/README.rst @@ -6,170 +6,7 @@ A git command for submitting branches to Gerrit git-review is a tool that helps submitting git branches to gerrit for review. -Setup ------ - -By default, git-review will look for a remote named 'gerrit' for working -with Gerrit. If the remote exists, git-review will submit the current -branch to HEAD:refs/for/master at that remote. - -If the Gerrit remote does not exist, git-review looks for a file -called .gitreview at the root of the repository with information about -the gerrit remote. Assuming that file is present, git-review should -be able to automatically configure your repository the first time it -is run. - -The name of the Gerrit remote is configurable; see the configuration -section below. - -Usage ------ - -Hack on some code, then:: - - git review - -If you want to submit that code to a branch other than "master", then:: - - git review branchname - -If you want to submit to a different remote:: - - git review -r my-remote - -If you want to supply a review topic:: - - git review -t topic/awesome-feature - -If you want to disable autogenerated topic:: - - git review -T - -If you want to submit a branch for review and then remove the local branch:: - - git review -f - -If you want to skip the automatic "git rebase -i" step:: - - git review -R - -If you want to download change 781 from gerrit to review it:: - - git review -d 781 - -If you want to download patchset 4 for change 781 from gerrit to review it:: - - git review -d 781,4 - -If you want to compare patchset 4 with patchset 10 of change 781 from gerrit:: - - git review -m 781,4-10 - -If you just want to do the commit message and remote setup steps:: - - git review -s - -.gitreview file format ----------------------- - -Example .gitreview file (used to upload for git-review itself):: - - [gerrit] - host=review.openstack.org - port=29418 - project=openstack-infra/git-review.git - defaultbranch=master - -Required values: host, project - -Optional values: port (default: 29418), defaultbranch (default: master), -defaultremote (default: gerrit). - -**Notes** - -* Username is not required because it is requested on first run - -* Unlike git config files, there cannot be any whitespace before the name - of the variable. - -* Upon first run, git-review will create a remote for working with Gerrit, - if it does not already exist. By default, the remote name is 'gerrit', - but this can be overridden with the 'defaultremote' configuration - option. - -* You can specify different values to be used as defaults in - ~/.config/git-review/git-review.conf or /etc/git-review/git-review.conf. - -Hooks ------ - -git-review has a custom hook mechanism to run a script before certain -actions. This is done in the same spirit as the classic hooks in git. - -There are two types of hooks, a global one which is stored in -~/.config/git-review/hooks/ and one local to the repository stored in -.git/hooks/ with the other git hook scripts. - -**The script needs be executable before getting executed** - -The name of the script is $action-review where action can be -: - -* pre - run at first before doing anything. - -* post - run at the end after the review was sent. - -* draft - run when in draft mode. - -if the script returns with an exit status different than zero, -git-review will exit with the a custom shell exit code 71. - -Installation ------------- - -Install with pip install git-review - -For assistance installing pip on your os check out get-pip: -http://pip.readthedocs.org/en/latest/installing.html - -For installation from source simply add git-review to your $PATH -after installing the dependencies listed in requirements.txt - -Running tests -------------- - -Running tests for git-review means running a local copy of Gerrit to -check that git-review interacts correctly with it. This requires the -following: - -* a Java Runtime Environment on the machine to run tests on - -* Internet access to download the gerrit.war file, or a locally - cached copy (it needs to be located in a .gerrit directory at the - top level of the git-review project) - -To run git-review integration tests the following commands may by run:: - - tox -e py27 - tox -e py26 - tox -e py32 - tox -e py33 - -depending on what Python interpreter would you like to use. - -Contributing ------------- - -To get the latest code, see: https://git.openstack.org/cgit/openstack-infra/git-review - -Bugs are handled at: https://storyboard.openstack.org/#!/project/719 - -There is a mailing list at: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-infra - -Code reviews, as you might expect, are handled by gerrit at: https://review.openstack.org - -Use ``git review`` to submit patches (after creating a gerrit account that links to your launchpad account). Example:: - - # Do your commits - git review - # Enter your username if prompted +* Free software: Apache license +* Documentation: http://docs.openstack.org/developer/git-review +* Source: https://git.openstack.org/cgit/openstack-infra/git-review +* Bugs: https://storyboard.openstack.org/#!/project/719 diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..38f8a493 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/git-review.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/git-review.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/git-review" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/git-review" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..42aa408f --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,252 @@ +# -*- coding: utf-8 -*- +# +# git-review documentation build configuration file, created by +# sphinx-quickstart on Mon Dec 1 14:06:22 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'oslosphinx', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'git-review' +copyright = u'2014, OpenStack Contributors' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'git-reviewdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'git-review.tex', u'git-review Documentation', + u'OpenStack Contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'git-review', u'git-review Documentation', + [u'OpenStack Contributors'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'git-review', u'git-review Documentation', + u'OpenStack Contributors', 'git-review', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/source/developing.rst b/doc/source/developing.rst new file mode 100644 index 00000000..9eded603 --- /dev/null +++ b/doc/source/developing.rst @@ -0,0 +1,23 @@ +.. include:: ../../CONTRIBUTING.rst + +Running tests +============= + +Running tests for git-review means running a local copy of Gerrit to +check that git-review interacts correctly with it. This requires the +following: + +* a Java Runtime Environment on the machine to run tests on + +* Internet access to download the gerrit.war file, or a locally + cached copy (it needs to be located in a .gerrit directory at the + top level of the git-review project) + +To run git-review integration tests the following commands may by run:: + + tox -e py27 + tox -e py26 + tox -e py32 + tox -e py33 + +depending on what Python interpreter would you like to use. diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..7134868c --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,22 @@ +============ + git-review +============ + +``git-review`` is a tool that helps submitting git branches to gerrit +for review. + +.. toctree:: + :maxdepth: 2 + + installation + usage + developing + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 00000000..0247ce54 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,85 @@ +================================ + Installation and Configuration +================================ + +Installing git-review +===================== + +Install with pip install git-review + +For assistance installing pip on your os check out get-pip: +http://pip.readthedocs.org/en/latest/installing.html + +For installation from source simply add git-review to your $PATH +after installing the dependencies listed in requirements.txt + +Setup +===== + +By default, git-review will look for a remote named 'gerrit' for working +with Gerrit. If the remote exists, git-review will submit the current +branch to HEAD:refs/for/master at that remote. + +If the Gerrit remote does not exist, git-review looks for a file +called .gitreview at the root of the repository with information about +the gerrit remote. Assuming that file is present, git-review should +be able to automatically configure your repository the first time it +is run. + +The name of the Gerrit remote is configurable; see the configuration +section below. + +.gitreview file format +====================== + +Example .gitreview file (used to upload for git-review itself):: + + [gerrit] + host=review.openstack.org + port=29418 + project=openstack-infra/git-review.git + defaultbranch=master + +Required values: host, project + +Optional values: port (default: 29418), defaultbranch (default: master), +defaultremote (default: gerrit). + +**Notes** + +* Username is not required because it is requested on first run + +* Unlike git config files, there cannot be any whitespace before the name + of the variable. + +* Upon first run, git-review will create a remote for working with Gerrit, + if it does not already exist. By default, the remote name is 'gerrit', + but this can be overridden with the 'defaultremote' configuration + option. + +* You can specify different values to be used as defaults in + ~/.config/git-review/git-review.conf or /etc/git-review/git-review.conf. + +Hooks +===== + +git-review has a custom hook mechanism to run a script before certain +actions. This is done in the same spirit as the classic hooks in git. + +There are two types of hooks, a global one which is stored in +~/.config/git-review/hooks/ and one local to the repository stored in +.git/hooks/ with the other git hook scripts. + +**The script needs be executable before getting executed** + +The name of the script is $action-review where action can be +: + +* pre - run at first before doing anything. + +* post - run at the end after the review was sent. + +* draft - run when in draft mode. + +if the script returns with an exit status different than zero, +git-review will exit with the a custom shell exit code 71. diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 00000000..a43c6749 --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,47 @@ +======= + Usage +======= + +Hack on some code, then:: + + git review + +If you want to submit that code to a branch other than "master", then:: + + git review branchname + +If you want to submit to a different remote:: + + git review -r my-remote + +If you want to supply a review topic:: + + git review -t topic/awesome-feature + +If you want to disable autogenerated topic:: + + git review -T + +If you want to submit a branch for review and then remove the local branch:: + + git review -f + +If you want to skip the automatic "git rebase -i" step:: + + git review -R + +If you want to download change 781 from gerrit to review it:: + + git review -d 781 + +If you want to download patchset 4 for change 781 from gerrit to review it:: + + git review -d 781,4 + +If you want to compare patchset 4 with patchset 10 of change 781 from gerrit:: + + git review -m 781,4-10 + +If you just want to do the commit message and remote setup steps:: + + git review -s diff --git a/setup.cfg b/setup.cfg index 11b1caea..c37827d5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -29,3 +29,11 @@ console_scripts = [wheel] universal = 1 + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[pbr] +warnerrors = True \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index 8a458d19..8331444c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,3 +4,5 @@ mock fixtures>=0.3.14 testrepository>=0.0.18 testtools>=0.9.34 +oslosphinx +sphinx>=1.1.2,!=1.2.0,<1.3 diff --git a/tox.ini b/tox.ini index 30345798..59bec38f 100644 --- a/tox.ini +++ b/tox.ini @@ -2,6 +2,7 @@ envlist = py26,py27,py32,py33,py34,pep8 [testenv] +install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} @@ -19,6 +20,9 @@ commands = flake8 [testenv:sdist] commands = python setup.py sdist {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [testenv:venv] commands = {posargs}