summaryrefslogtreecommitdiff
path: root/HowToContributeToThisWiki.mdwn
diff options
context:
space:
mode:
authorThomas Schwinge <tschwinge@gnu.org>2007-08-10 13:08:06 +0200
committerThomas Schwinge <tschwinge@gnu.org>2007-08-10 13:08:06 +0200
commit6dcdf3bd6583b351c1be19c91eec1e0cab24af47 (patch)
treec2fa772e8804bbdecf7ca7273776c0ed63e085ee /HowToContributeToThisWiki.mdwn
parentfe545238b5cded0ea9ddb520da6ce7705c9018d4 (diff)
Extend some more.
Diffstat (limited to 'HowToContributeToThisWiki.mdwn')
-rw-r--r--HowToContributeToThisWiki.mdwn40
1 files changed, 28 insertions, 12 deletions
diff --git a/HowToContributeToThisWiki.mdwn b/HowToContributeToThisWiki.mdwn
index a6267d64..cb3f3446 100644
--- a/HowToContributeToThisWiki.mdwn
+++ b/HowToContributeToThisWiki.mdwn
@@ -25,11 +25,24 @@ Consult the git documentation about how to shuffle around with branches, how to
rename files, how to upload arbitrary data files, and so on.
+First, let's make sure that you're properly identifying yourself towards git.
+
+ $ git var GIT_AUTHOR_IDENT
+ Thomas Schwinge <tschwinge@gnu.org> 1186743435 +0200
+
+If it doesn't look akin to that for you, you'd better adjust either your
+*EMAIL* environment variable or alternatively tell git about your real
+identity:
+
+ $ git config --global user.name 'Your Name'
+ $ git config --global user.email you@somewhere.invalid
+
+
For being able to do a checkout from which you can later directly push your
changes back into the master repository, you need a
[[shell_account_on_*flubber*|Hurd/PublicHurdBoxen]]. (It's also very much
recommenable that you set up your local ssh configuration as advised on that
-page.)
+page.) If you have an account on there:
$ git clone flubber:~wiki/wiki [dest]
@@ -40,35 +53,39 @@ still get the pages the read-only way.
$ git clone git://flubber.bddebian.com/wiki [dest]
-If that also doesn't work out, you have another chance: pull over the http
-protocol. Not very efficient (read: very inefficient), but it works. This is
-also read-only.
+If that also doesn't work out, you have yet another chance: pull over the http
+protocol. Not very efficient (read: rather inefficient), but it works. This
+is also read-only.
$ git clone http://www.bddebian.com/git/wiki [dest]
For all cases: if you omit *[dest]* it will default to *wiki*.
Later, you can just *cd* into the *wiki* directory and run a *git pull* to get
-hold of the latest changes others have installed.
+hold of the latest changes others have been installing in the mean time.
But now: work on these files.
$ cd wiki/
$ emacs Hurd/NextHurd.mdwn
+ $ # Check what you've done.
+ $ git diff Hurd/NextHurd.mdwn
$ git commit Hurd/NextHurd.mdwn
[...]
+ $ # Add a new file.
$ emacs Hurd/DesignGoals.mdwn
+ $ git add Hurd/DesignGoals.mdwn
$ git commit Hurd/DesignGoals.mdwn
[...]
$ [...]
Remember that at this stage your commits have only been installed into your
-personal working copy. So, finally you'll explicitly have to install your
-changes into the master repository.
+personal working copy. You'll finally have to explicitly install your changes
+into the master repository, see below.
-You can also get them locally rendered to html pages.
+You can also locally get the whole wiki rendered to html pages:
$ wiki/render_locally
[...]
@@ -80,8 +97,7 @@ You can also get them locally rendered to html pages.
If you like what you've done, then it's now time to publish your changes.
-If you can push directly into the master repository this is as simple as
-follows.
+If you can push directly into the master repository this is really simple:
$ git push
updating 'refs/heads/master'
@@ -91,7 +107,7 @@ follows.
[...]
Updating web pages. This may up to a few minutes at the utmost...
-If you can't do that, then first prepare to publish your changes.
+If you can't do that, then first prepare to publish your changes:
$ git-format-patch -M -B origin
0001-Be-a-bit-more-expressive.patch
@@ -101,7 +117,7 @@ See through the generated **.patch* files and simply delete those you don't
want to pulish.
Finally, publish the good ones. If you have a local mail transfer agent
-running, the following is all you have to do.
+running, the following is all you have to do:
$ git-send-email --to web-hurd@gnu.org *.patch
[...]