Re: Git documentation reorganization and cleanup
2009/4/18 Sandy Armstrong sanfordarmstr...@gmail.com: Hi all, Just a quick note that I've been working a bit on cleaning up our git documentation. It is now centralized here: http://live.gnome.org/Git And the main developer howto has been simplified. It now recommends a single simple workflow of hacking, making a single commit, and generating a patch using `git format-patch HEAD^`: http://live.gnome.org/Git/Developers I really want to keep this page comprehensible for new contributors, as much as we can. If you have ideas for how to improve it, any help is welcome. Please keep in mind that I'm actually pretty new to git, and may not be aware of better workflows for new contributors. Hi Sandy, great job. However I miss some docs for maintainers of new modules. In freedesktop when you have a new empty repository, you can't clone that repository (something that sounds like the natural first step, specially for people used to subversion). So you have to create your own repository, push it, and then set the origin properly. I found this step pretty confusing at the time. I'd like to add Git/FAQ and a page about workflows and/or branching strategies, as well as how to share branches via gitorious, github, etc. If anyone is interested in this, any content is better than no content. I'd rather see a FAQ full of unanswered questions than a blank one. :-) I'm also particularly interested in having good documentation for Windows and Mac users, so if anybody is already working on something similar, I'd love to hear about it. Let's try to keep our git documentation under l.g.o/Git/. Best, Sandy ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list -- Un saludo, Alberto Ruiz ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Git documentation reorganization and cleanup
On Sat, Apr 18, 2009 at 7:17 AM, Alberto Ruiz ar...@gnome.org wrote: 2009/4/18 Sandy Armstrong sanfordarmstr...@gmail.com: Hi all, Just a quick note that I've been working a bit on cleaning up our git documentation. It is now centralized here: http://live.gnome.org/Git And the main developer howto has been simplified. It now recommends a single simple workflow of hacking, making a single commit, and generating a patch using `git format-patch HEAD^`: http://live.gnome.org/Git/Developers I really want to keep this page comprehensible for new contributors, as much as we can. If you have ideas for how to improve it, any help is welcome. Please keep in mind that I'm actually pretty new to git, and may not be aware of better workflows for new contributors. Hi Sandy, great job. However I miss some docs for maintainers of new modules. In freedesktop when you have a new empty repository, you can't clone that repository (something that sounds like the natural first step, specially for people used to subversion). So you have to create your own repository, push it, and then set the origin properly. I found this step pretty confusing at the time. http://live.gnome.org/NewGITRepos I'll make sure more places link to this. Thanks for the feedback, Sandy ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Git documentation reorganization and cleanup
On Fri, 2009-04-17 at 16:13 -0700, Sandy Armstrong wrote: Hi all, Just a quick note that I've been working a bit on cleaning up our git documentation. It is now centralized here: http://live.gnome.org/Git And the main developer howto has been simplified. It now recommends a single simple workflow of hacking, making a single commit, and generating a patch using `git format-patch HEAD^`: http://live.gnome.org/Git/Developers I really want to keep this page comprehensible for new contributors, as much as we can. If you have ideas for how to improve it, any help is welcome. Please keep in mind that I'm actually pretty new to git, and may not be aware of better workflows for new contributors. Thanks a lot for working on this, Sandy. One area that someone could fix up is the section in /Developers about branches whiich currenlt ysays: === In Git, branches and tags are simply references to a commit. You can check out a branch using the following command, once you have cloned the project: git checkout [branch name] For a list of the available branches for a given project: git branch -r The following example will check out gnome-utils master and then check out the 'gnome-2-0' branch: git clone git://git.gnome.org/gnome-utils cd gnome-utils git checkout gnome-2-0 === That obviously doesn't work - it needs to show: git checkout -b [branch name] origin/[branch name] For initially creating the local branch, and have some explanation of what is going on. (It's a little confusing here to use git checkout -b to create the branch... multiple things going on at once; but 'git checkout -b' has the important side-effect of setting up the new branch to pull from the origin, which you would have to do manually if you used 'git branch' to create the branch.) - Owen ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Git documentation reorganization and cleanup
On Sat, Apr 18, 2009 at 5:14 PM, Santi Béjar sa...@agolina.net wrote: 2009/4/18 Owen Taylor otay...@redhat.com: === In Git, branches and tags are simply references to a commit. You can check out a branch using the following command, once you have cloned the project: git checkout [branch name] For a list of the available branches for a given project: git branch -r The following example will check out gnome-utils master and then check out the 'gnome-2-0' branch: git clone git://git.gnome.org/gnome-utils cd gnome-utils git checkout gnome-2-0 === That obviously doesn't work - it needs to show: git checkout -b [branch name] origin/[branch name] For initially creating the local branch, and have some explanation of what is going on. (It's a little confusing here to use git checkout -b to create the branch... multiple things going on at once; but 'git checkout -b' has the important side-effect of setting up the new branch to pull from the origin, which you would have to do manually if you used 'git branch' to create the branch.) git branch [branch name] origin/[branch name] also does the setup the same way as ´git checkout -b´. In Git 1.6.1 or newer, one can do git checkout --track origin/[branch name] and this creates the [branch name] branch. The usability benefit is not having to write the branch name twice. It appears a common error with 'git checkout -b [branch name] origin/[branch name]' is that when you write by accident as 'git checkout -b origin/[branch name]' the command succeeds, but it creates a local branch which is a copy of 'master', and has the name 'origin/[branch name]'. 'git checkout' does not warn if you create a branch name with a '/' in the name. In older versions of Git, the git checkout --track origin/[branch name] syntax does not work due to a bug, http://lkml.org/lkml/2008/12/25/8 «* git checkout --track origin/hack used to be a syntax error. It now DWIMs to create a corresponding local branch hack, i.e. acts as if you said git checkout --track -b hack origin/hack.» Simos ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Git documentation reorganization and cleanup
On 04/18/2009 10:38 AM, Sandy Armstrong wrote: http://live.gnome.org/NewGITRepos I'll make sure more places link to this. Move it under Git/? behdad Thanks for the feedback, Sandy ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
Git documentation reorganization and cleanup
Hi all, Just a quick note that I've been working a bit on cleaning up our git documentation. It is now centralized here: http://live.gnome.org/Git And the main developer howto has been simplified. It now recommends a single simple workflow of hacking, making a single commit, and generating a patch using `git format-patch HEAD^`: http://live.gnome.org/Git/Developers I really want to keep this page comprehensible for new contributors, as much as we can. If you have ideas for how to improve it, any help is welcome. Please keep in mind that I'm actually pretty new to git, and may not be aware of better workflows for new contributors. I'd like to add Git/FAQ and a page about workflows and/or branching strategies, as well as how to share branches via gitorious, github, etc. If anyone is interested in this, any content is better than no content. I'd rather see a FAQ full of unanswered questions than a blank one. :-) I'm also particularly interested in having good documentation for Windows and Mac users, so if anybody is already working on something similar, I'd love to hear about it. Let's try to keep our git documentation under l.g.o/Git/. Best, Sandy ___ desktop-devel-list mailing list desktop-devel-list@gnome.org http://mail.gnome.org/mailman/listinfo/desktop-devel-list
