x
/
git-upstream
Code Issues Proposed changes

Add a brief and clear description of git-upstream main usecase 

Add a brief and clear description of git-upstream main usecase in
README.md and DESCRIPTION file.
This commit is contained in:
Davide Guerri 2014-07-25 23:53:51 +01:00
parent 89613bd388
commit 2efd054714
2 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
DESCRIPTION
View File

@ -3,17 +3,37 @@
git-upstream is an open source Python application that can be used to keep in
sync with upstream open source projects, mainly OpenStack.
The main usecase for this tool is for people who are doing active contributions
to repositories that are mirrors of OpenStack repositories, with the intention
that most of those contributions will be submitted to review.openstack.org at
some point.
If you are running a public cloud based on OpenStack, having local changes
needed to use it in your environment, you can use git-upstream to stay up to
date with the upstream master in a easier way (with respect to using raw git
commands).
git-upstream provides new git subcommands to support rebasing of local-carried
patches on top of upstream repositories. It provides commands to ease the use of
git for who needs to integrate big upstream projects in their environment.
patches on top of upstream repositories. It provides commands to ease the use
of git for who needs to integrate big upstream projects in their environment.
The operations are performed using Git commands.
See also README.md, USAGE.md and KNOWN-ISSUES.md files.
- What git-upstream is not
The name of this tool includes the "git-" prefix because of the Git naming
convention that a Git subcommand must have. So, as git-review (usually invoked
with "git review [...]"), this tool can be invoked using "git upstream [...]".
That said, and even if git-upstream currently uses Change-Ids, it is not
strictly related to git-review.
In other words, git-review can (and most of the time will) be used without even
knowing about git-upstream existence.
- How can I contribute to git-upstream?
Git-upstream is currently (and temporarily) hosted on Github, here:
https://github.com/dguerri/git-upstream
As any other Github project, just fork it, implement your changes and submit a pull request.
As any other Github project, just fork it, implement your changes and submit a
pull request.

5
README.md
View File

@ -2,6 +2,9 @@
git-upstream is an open source Python application that can be used to keep in sync with upstream open source projects, mainly OpenStack.
The main usecase for this tool is for people who are doing active contributions to repositories that are mirrors of OpenStack repositories, with the intention that most of those contributions will be submitted to review.openstack.org at some point.
If you are running a public cloud based on OpenStack, having local changes needed to use it in your environment, you can use git-upstream to stay up to date with the upstream master in a easier way (with respect to using raw git commands).
git-upstream provides new git subcommands to support rebasing of local-carried patches on top of upstream repositories. It provides commands to ease the use of git for who needs to integrate big upstream projects in their environment. The operations are performed using Git commands.
**Note**: currently git-upstream can be used only for projects that are maintained with Gerrit as it relies on the presence of Change-IDs.
@ -45,7 +48,7 @@ This means jobs run by Jenkins can save a detailed log file separately as an art
The name of this tool includes the "git-" prefix because of the Git naming convention that a Git subcommand must have.
So, as git-review (usually invoked with "git review [...]"), this tool can be invoked using "git upstream [...]".
That said, and even if git-upstream uses Change-ids generated by git-review, it ***is not*** stricly related to git-review.
That said, and even if git-upstream currently uses Change-Ids, it is not strictly related to git-review.
In other words, git-review can (and most of the time will) be used without even knowing about git-upstream existence.
# git-upstream installation