git/contrib
Jeremie Nikaes 428c995c4e Add a remote helper to interact with mediawiki (fetch & push)
Implement a gate between git and mediawiki, allowing git users to push
and pull objects from mediawiki just as one would do with a classic git
repository thanks to remote-helpers.

The following packages need to be installed (available on common
repositories):

  libmediawiki-api-perl
  libdatetime-format-iso8601-perl

Use remote helpers in order to be as transparent as possible to the git
user.

Download Mediawiki revisions through the Mediawiki API and then
fast-import into git.

Mediawiki revision number and git commits are linked thanks to notes
bound to commits.

The import part is done on a refs/mediawiki/<remote> branch before
coming to refs/remote/origin/master (Huge thanks to Jonathan Nieder
for his help)

We use UTF-8 everywhere: use encoding 'utf8'; does most of the job, but
we also read the output of Git commands in UTF-8 with the small helper
run_git, and write to the console (STDERR) in UTF-8. This allows a
seamless use of non-ascii characters in page titles, but hasn't been
tested on non-UTF-8 systems. In particular, UTF-8 encoding for filenames
could raise problems if different file systems handle UTF-8 filenames
differently. A uri_escape of mediawiki filenames could be imaginable, and
is still to be discussed further.

Partial cloning is supported using one of:

git clone -c remote.origin.pages='A_Page  Another_Page' mediawiki::http://wikiurl

git clone -c remote.origin.categories='Some_Category' mediawiki::http://wikiurl

git clone -c remote.origin.shallow='True' mediawiki::http://wikiurl

Thanks to notes metadata, it is possible to compare remote and local last
mediawiki revision to warn non-fast forward pushes and "everything
up-to-date" case.

When allowed, push looks for each commit between remotes/origin/master
and HEAD, catches every blob related to these commit and push them in
chronological order. To do so, it uses git rev-list --children HEAD and
travels the tree from remotes/origin/master to HEAD through children. In
other words:

* Shortest path from remotes/origin/master to HEAD
* For each commit encountered, push blobs related to this commit

Signed-off-by: Jérémie Nikaes <jeremie.nikaes@ensimag.imag.fr>
Signed-off-by: Arnaud Lacurie <arnaud.lacurie@ensimag.imag.fr>
Signed-off-by: Claire Fousse <claire.fousse@ensimag.imag.fr>
Signed-off-by: David Amouyal <david.amouyal@ensimag.imag.fr>
Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Signed-off-by: Sylvain Boulmé <sylvain.boulme@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-09-01 15:52:55 -07:00
..
blameview War on whitespace 2007-06-07 00:04:01 -07:00
buildsystems msvc: Fix an "unrecognized option" linker warning 2010-01-22 16:15:14 -08:00
ciabot contrib/ciabot: git-describe commit instead of HEAD 2010-10-29 14:09:48 -07:00
completion Merge branch 'js/ref-namespaces' 2011-08-17 17:35:38 -07:00
continuous contrib/continuous: a continuous integration build manager 2007-03-19 22:21:19 -07:00
convert-objects Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
emacs git.el: Don't use font-lock-compile-keywords 2011-04-03 11:08:54 -07:00
examples cherry-pick/revert: add support for -X/--strategy-option 2010-12-28 11:27:56 -08:00
fast-import git-p4: commit time should be most recent p4 change time 2011-08-01 10:24:20 -07:00
git-shell-commands Add sample commands for git-shell 2010-08-12 15:16:31 -07:00
gitview Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
hg-to-git Correct references to /usr/bin/python which does not exist on FreeBSD 2010-03-24 14:33:54 -07:00
hooks Add option hooks.diffopts to customize change summary in post-receive-email 2011-08-04 12:06:49 -07:00
mw-to-git Add a remote helper to interact with mediawiki (fetch & push) 2011-09-01 15:52:55 -07:00
p4import Correct references to /usr/bin/python which does not exist on FreeBSD 2010-03-24 14:33:54 -07:00
patches INSTALL: add warning on docbook-xsl 1.72 and 1.73 2007-08-04 01:55:08 -07:00
stats contrib: update packinfo.pl to not use dashed commands 2008-10-18 06:20:27 -07:00
svn-fe Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
thunderbird-patch-inline contrib/thunderbird-patch-inline: do not require bash to run the script 2011-03-30 12:29:39 -07:00
vim contrib/vim: change URL to point to the latest syntax files 2009-01-12 23:36:03 -08:00
workdir prefer test -h over test -L in shell scripts 2010-09-27 10:48:23 -07:00
git-resurrect.sh request-pull: protect against OPTIONS_KEEPDASHDASH from environment 2010-05-01 11:02:21 -07:00
README War on whitespace 2007-06-07 00:04:01 -07:00
remotes2config.sh contrib: Make remotes2config.sh script more robust 2007-12-04 14:35:08 -08:00
rerere-train.sh Add contrib/rerere-train script 2008-09-29 09:15:41 -07:00

Contributed Software

Although these pieces are available as part of the official git
source tree, they are in somewhat different status.  The
intention is to keep interesting tools around git here, maybe
even experimental ones, to give users an easier access to them,
and to give tools wider exposure, so that they can be improved
faster.

I am not expecting to touch these myself that much.  As far as
my day-to-day operation is concerned, these subdirectories are
owned by their respective primary authors.  I am willing to help
if users of these components and the contrib/ subtree "owners"
have technical/design issues to resolve, but the initiative to
fix and/or enhance things _must_ be on the side of the subtree
owners.  IOW, I won't be actively looking for bugs and rooms for
enhancements in them as the git maintainer -- I may only do so
just as one of the users when I want to scratch my own itch.  If
you have patches to things in contrib/ area, the patch should be
first sent to the primary author, and then the primary author
should ack and forward it to me (git pull request is nicer).
This is the same way as how I have been treating gitk, and to a
lesser degree various foreign SCM interfaces, so you know the
drill.

I expect that things that start their life in the contrib/ area
to graduate out of contrib/ once they mature, either by becoming
projects on their own, or moving to the toplevel directory.  On
the other hand, I expect I'll be proposing removal of disused
and inactive ones from time to time.

If you have new things to add to this area, please first propose
it on the git mailing list, and after a list discussion proves
there are some general interests (it does not have to be a
list-wide consensus for a tool targeted to a relatively narrow
audience -- for example I do not work with projects whose
upstream is svn, so I have no use for git-svn myself, but it is
of general interest for people who need to interoperate with SVN
repositories in a way git-svn works better than git-svnimport),
submit a patch to create a subdirectory of contrib/ and put your
stuff there.

-jc