Commit Graph

25 Commits

Author SHA1 Message Date
Clark Boylan 12a0aca425 Switch from tox to nox
Recent tox releases have put us on a config treadmill. Avoid these
issues entirely by using nox. Nox is a tox alternative that uses
standard tools like pip and should be simpler to use for us.

Change-Id: Ie79845bbed7ca1254aec466bd5219186fefcdac9
2023-03-13 10:19:07 -07:00
Jeremy Stanley 7009d7d03d Clarify that test rebases are not kept
There has been a long-standing misconception that git-review pushes
automatically rebased changes by default. It does not, but our
documentation and context help have been less than clear on that
point, contributing to this impression. Try to do a better job of
explaining that the default rebasing performed by git-review is
purely exploratory, and used only to notify users about possible
merge conflicts with their target branch before pushing a change.

Change-Id: I3c841af5ff9430a0de4d9dc9526dd3be6ab53ad2
2022-07-15 18:21:27 +00:00
Florian Haas 04786cd9ea Doc updates for Git "core.hooksPath" option support
Couple of small follow-ups to Id8a3ac464ff75e6d8207f198089f018cc790eca5:

* Fix formatting in the reno (use monospace as applicable).
* Update "Installation and Configuration" to say that the local hook
  *normally* goes into .git/hooks.

Change-Id: I1b326bdcaed38d3a82a65f944431f3640652dd33
2021-06-24 12:06:12 +02:00
Jeremy Stanley 319953d5ab Overhaul Python package metadata and OpenDev URLs
Modernize our package metadata in the following ways:

* switch from description-file to long_description with the file
  attribute, and specify an explicit content type and encoding

* replace the home-page parameter with the newer general url one

* add specific labelled project links for improved navigation from
  PyPI's summary sidebar

* add commandline keyword to help folks searching

* use the specific license metadata in addition to the corresponding
  trove classifier for it

* make sure wheels when built also incorporate the LICENSE and
  AUTHORS files so that we're not distributing them without a copy
  of the license text

* stop flagging wheels as "universal" now that git-review no longer
  supports Python 2.7

* drop the old Sphinx integration config for PBR now that it's no
  longer needed

https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html

Also update old openstack.org URLs throughout contributor docs and
examples/comments to newer opendev.org counterparts. Remove the old
redundant HACKING.rst file as well as a lingering MANIFEST.in from
the times before PBR was a thing. Replace the CONTRIBUTING.rst with
a shorter one cribbed from bindep. Add the test profile to the one
entry in bindep.txt to make it more apparent that's not a runtime
dependency of git-review. Adjust some old "OpenStack, LLC."
copyrights as indicated by the foundation's "Legal Issues FAQ."

Change-Id: Ie45d4d73ba7b5a860f09cc4f1d849587761d846c
2021-02-26 20:45:24 +00:00
Jeremy Stanley d3afb8039f Switch to default Sphinx theme
Since we're publishing documentation to docs.opendev.org now, drop
the openstackdocstheme extension and just use the default Alabaster
theme instead. Also clean up references to OpenStack in the Sphinx
configuration and remove a really old (and unnecessary) copyright
year.

Change-Id: I535783db9dccd36a094d41e6cf08469b6d8c3894
2021-02-26 18:15:43 +00:00
David Ostrovsky 02491ca845 Discontinue support for draft workflow
As of gerrit 2.15 and later, draft workflow is replaced with
work-in-progress and private workflow. See this CL: [1] and this
issue upstream: [2].

Even though support for draft worklfow was removed, the drafts magic
draft option was preserved, and is mapped to creation of the private
change when pushed first time, or creation of change edit on subsequent
pushes. These behaviour was alaways controvesial, but was kept in place
because 2 major Gerrit clients: repo and git-review were still
referencing drafts magic branch. In upcoming gerrit releases the support
for drafts magic branch option is discontinued, and thus removed from
both repo and git-review: [3].

[1] https://gerrit-review.googlesource.com/c/gerrit/+/97230
[2] https://crbug.com/gerrit/6880
[3] https://gerrit-review.googlesource.com/c/gerrit/+/238898

Sem-Ver: api-break
Change-Id: I08a590d42e1ebaa230da960cd192c0b1df528332
2020-01-17 16:36:41 +09:00
Stephen Finucane 7a660253f1 docs: Call out use of an agent to store SSH passwords
This is included as a note on the usage page for want of a better place
to put it.

Change-Id: I647cc8239e04e1f064aef3e0942ca94b0d5b4025
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Story: 2000431
Task: 2663
2018-10-24 15:27:48 +01:00
Stephen Finucane f4b46e56be docs: Misc updates
I tried splitting these into separate commits but the splits were too
abstract.

Change-Id: I996c920e861d7507d0d0bb41ba4f5e65362e0b44
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Story: 1388398
Task: 584
2018-10-15 15:01:16 +01:00
Monty Taylor c7436f95c9 Start using reno for releasenotes
It's probably a good idea to be specific about what's changing in reno
releases.

Since reno support wasn't in tree we didn't pick up notes for these two
changes, but they're things users might want to know about.

Change-Id: I249a3a4d0cf378b60bf43ce65d49416879d5517e
2018-08-28 15:13:05 -07:00
Monty Taylor 8236cdbf37 Use doc/requirements and openstackdocstheme
oslosphinx is the old hotness. openstackdocstheme is the new hotness.
Also, we can use doc/requirements.txt for docs requirements.

Change-Id: I9cbc670c8fb065d240251f061919479c87193ff5
2018-08-28 15:13:00 -07:00
Ian Wienand 2ee19d3526 Add a note on Windows and Unicode
Add a rough note on what we've discovered about Windows and Unicode.
tl;dr use Python 3.6+

Change-Id: I219cfca6cb9ad427a55a7a1821f9fe0a9cf632f3
2017-11-17 14:09:10 +11:00
Clark Boylan d3d66a4715 Support git 2.15 and newer
The 2.15 release of git drops support for `git branch --set-upstream`
and replaces it with `git branch --set-upstream-to` which was added in
git 1.8. Move from --set-upstream to --set-upstream-to in order to
support git 2.15 and beyond. Note that this specifically affects the
`git review -d` functionality as it is what needs to update the
upstream.

This does drop support for git 1.7 and older though as this option did
not exist then. Polling linux distros and OS X the oldest git I can find
is on CentOS 7 which has 1.8 so this should be fine.

Story: 2001266
Co-Authored-By: Harry Mallon <Harry.Mallon@codex.online>
Change-Id: I5ded1ab39bb2c76bdc38655299bac11b4584e138
2017-11-05 15:26:18 -08:00
Ian Y. Choi e6c8e644b2 Provide link to MediaWiki platform specific page
Provide a link to the MediaWiki page on git-review installation, which
provides details for a range of platforms, including Windows and OS
X/macOS.

Change-Id: If030fa7614a7cea33c2a55605a6f0d68751173ea
Story: #2000481
2017-05-16 14:20:10 +10:00
Jenkins 802044859f Merge "Add “git-review -l” to man page synopsis and usage doc" 2015-06-12 19:14:00 +00:00
Clint Adams c5a7bd09b3 Add “git-review -l” to man page synopsis and usage doc
The man page currently contains a description for -l,--list
but it is missing from the SYNOPSIS.

Change-Id: Ide808b9ad89ba68856365c90817a1dcda189735c
2015-06-12 11:39:31 -04:00
Michael Pratt bb7395009d Add reviewers on upload
Add the --reviewers argument which allows specifying reviewers to be
added to each patch uploaded.  This simplifies the upload process by not
requiring an additional step of adding reviewers to changes.

Gerrit supports specifying reviewers to be added to changes by appending
a list of r='email' options to the refspec being pushed to.  For
example, from the Gerrit 'Uploading Changes' documentation:

git push tr:kernel/common HEAD:refs/for/experimental%r=a@a.com,cc=b@o.com

The --reviewers argument can be passed multiple reviewers to add to the
patch set.  Reviewers containing whitespace are rejected, as whitespace
cannot be added to the refspec.

Change-Id: I8c2f9453a90dd78aa47f7996f2502f9f6cf2d66d
2015-06-12 14:37:42 +00:00
Cedric Brandily 910ffddd1b Support authentication in run_http_exc
Authentication could be required when performing REST API authenticated
queries over http(s) (done by run_http_exc). Typically, it appends with
gerrit behind apache2.

This change queries git credential for gerrit password when http request
returns a 401.

Change-Id: Iad60eea938c42210ba8c5df4a1b76f8d2f4dd76d
2015-02-27 16:17:35 +01:00
Doug Hellmann b6aab6d9d6 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
2015-02-03 17:38:50 +01:00
Monty Taylor 1b20aa2df3 Replace sphinx manpage with manual one.
If we upload source tarballs to PyPI instead of eggs, then the man
pages actually work. However, this means that the installer has to
run setup.py. Using sphinx, while slighly nicer from a dev
perspective, means we have to then require that people installing
git-review also install sphinx, which is a bit overkill given the
size of the man page.

This change, and a change to the release process of not uploading
eggs to PyPI should finall get git review --help to work.

Change-Id: I29b07667127a9ec5c241b7e1fc5a3960dd2a6b63
2011-10-29 22:24:53 -04:00
James E. Blair b8b908af1f Clean up documentation; add --version.
Move manual gerrit remote setup docs from README to man page
(that's advanced usage).

Remove rendundant documentation from the README.

Add --version option.

Add documentation on contributing.

Change-Id: I624b56a629a6120e91ef1bfa0f4bb801b60b9d5d
2011-10-27 16:28:46 -04:00
James E. Blair 22cdd15b5d Check .gitreview file in repo for location of gerrit.
Change-Id: I5f344bb28155c42538c4a93ea0cefbef999a2957
2011-10-14 13:24:53 -04:00
Monty Taylor 95e15c4415 Add --setup command for a pro-active repo setup.
Original Author:    Monty Taylor <mordred@inaugust.com>
Updated to fix pep8 violations.

Change-Id: Ib774eb176e78770d2ebb938adc43e612d17236bb
2011-10-14 10:19:16 -04:00
Monty Taylor 08bd9cf1e8 Added support for download command.
Change-Id: I3ebfa01e8f3454822170ee0d183de15dfb0b1f8a
2011-10-04 23:38:40 -04:00
Monty Taylor fb25d21c7a Added support for updating. 2011-09-26 11:07:54 -07:00
Monty Taylor 2a78c60835 Ported rfc.sh to a standalone program. 2011-09-25 09:16:31 -07:00