Trivial change to documentation

[Dirk Hohndel]

On Mar 5, 2013, at 7:29 AM, Peter Konings wrote:

> I read it and would like to propose a few impovements... but I'm not a programmer. Could anybody run me through the basic git commands needed to submit a patch?

I'll need to add more about this to the Contributing page on the web site :-)

It's really easy.

Start with getting the latest source

(I assume you already did the git clone)

cd subsurface
git checkout master
git pull

ok, now we know you're on the latest version

$(EDITOR) Documentation/user-manual.txt
make doc
$(BROWSER) Documentation/user-manual.html

(repeat as necessary)

git commit -s -a

(opens $(GIT_EDITOR) or (if unset) $(EDITOR) to edit commit message - if you are unfamiliar with vi, make sure you set one of those environment variables, first)

Write a good commit message. Something like this

Documentation: high level what I changed
<empty line>
More description of what you changed and why

Signed-off-by:…

The SOB line should be pre-populated (that's what the '-s' does… the '-a' simply adds all modified files)

If you want to change the commit message, "git commit --amend" is the way to go.

If you add a new picture, you need to tell git about it

git add Documentation/images/great-screenshot.png
git commit -s -a

feel free to break your changes into multiple smaller commits.

Then, when you are done run

git format-patch HEAD~1    (or ~2 or however many commits you made)

send those files with a brief email explaining the changes to the list

/D

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4130 bytes
Desc: not available
URL: <http://lists.hohndel.org/pipermail/subsurface/attachments/20130305/1ed301ab/attachment.bin>