emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Carsten Dominik <dominik@science.uva.nl>
To: Ian Barton <lists@manor-farm.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: Best Way to Submit a Patch
Date: Mon, 15 Dec 2008 07:02:19 +0100	[thread overview]
Message-ID: <B1DA5530-88A5-4E07-93B2-747C86DB9811@uva.nl> (raw)
In-Reply-To: <49452CE8.8070104@manor-farm.org>

Hi Ian,

there is lots of GIT documentation on the web.  Here is a short way to  
do what you want.

1. get the latest changes

    git pull

2. create a branch for you to do your changes

    git checkout -b my-doc-fixed

3. Edit the file you want to change

    $ emacs ....
    $ emacs ....

4. Commit the changes when you feel like it

    git add doc/org.texi
    git commit

5. Create a patch

    git diff master > send-to-carsten.patch

6. Go back t the master branch for normal use of Org-mode.
    Do this only after committing all changes.

    git checkout master

This all works fine when you don't pull new changes while
working on your patch.  If Org changes while you do your work,
you can do this:

- commit your changes as described above.
- switch back to master

   git checkout master

- get new changes

   git pull

- return to your branch

   git checkout my-doc-fixes

- make sure your changes are made relative to the current, new master:

   git rebase master

- continue working on your patches.

The only problem here is that git rebase can fail if there is overlap,
so my recommendation for he beginner is to just use the workflow
shown above.

- Carsten

P.S.  I am *not* a GIT guru, I hope others will correct me if anything  
should be done differently.

On Dec 14, 2008, at 4:57 PM, Ian Barton wrote:

> I would like to submit some patches for the documentation. Whilst I  
> understand how to make a patch file, what should I be patching  
> against? I am running a clone of the git repo, so  presume I can  
> somehow use git to create patches. Can someone point me to the  
> documentation on how to get started?
> I guess my first contribution should be "How to submit a patch" :)
> Ian.
> _______________________________________________
> Emacs-orgmode mailing list
> Remember: use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

  reply	other threads:[~2008-12-15  6:02 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-12-14 15:57 Best Way to Submit a Patch Ian Barton
2008-12-15  6:02 ` Carsten Dominik [this message]
2008-12-15 10:15   ` Ian Barton
2008-12-16  8:47     ` Jeff Mickey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=B1DA5530-88A5-4E07-93B2-747C86DB9811@uva.nl \
    --to=dominik@science.uva.nl \
    --cc=emacs-orgmode@gnu.org \
    --cc=lists@manor-farm.org \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).