VideoLAN Wiki - User contributions [en]

VideoLAN Team

2010-02-14T11:28:59Z

Sam Hocevar: hide User prefix

This page is intended to help to know who's who.

You don't have to have a SVN write access to put your name here. If you hang out frequently on irc or on the forum write your name here.

(should probably be merged with http://www.videolan.org/team/index.html )

'' You can add yourself to the list following alphabetical order.''

{|
|+ VideoLAN Team
! align=left width=200 | Real name !! align=left width=100 | IRC Nick !!align=left width=100| SVN login !! align=left width=100 | wiki login !!align=left width=100 | Forum login !!
|-
| Filippo Carone || littlejohn || littlejohn || ? || ?
|-
| Rafaël Carré || funman || funman || [[User:Funman|Funman]] || funman
|-
| Antoine Cellerier || dionoea || dionoea || [[User:Dionoea|Dionoea]] || dionoea
|-
| Jerome Decoodt || DiDjCodt || djc || ? || ?
|-
| Rémi Denis-Courmont || courmish || courmish || [[User:Courmisch|Courmisch]] || Rémi Denis-Courmont
|-
| Pierre d'Herbemont || pdherbemont || pdherbemont || [[User:Pdherbemont|Pdherbemont]] || pdherbemont
|-
| Damien Fouilleul || Quovodis || damienf || [[User: Quovodis|Quovodis]] || ?
|-
| Sam Hocevar || sam || sam || [[User:Sam Hocevar|Sam Hocevar]] ||
|-
| Jean-Baptiste Kempf || j-b || jb || [[User:J-b|J-b]] || j-b
|-
| Pavlov Konstantin || thresh || thresh || [[User: Thresh|Thresh]] || thresh
|-
| Felix Paul Kühne || feepk || fkuehne || [[User:Fkuehne|Fkuehne]] || feepk
|-
| Christophe Massiot || Meuuh || meuuh || ? || ?
|-
| Christophe Mutricy || xtophe || xtophe || ? || ?
|-
| Ilkka Ollakka || ILEoo || ileoo || ? || ?
|-
| Faustino Osuna || riquedafreak || riquedafreak || [[User:Riquedafreak|Riquedafreak]] || riquedafreak
|-
| Yoann Peronneau || yoannp || yoann || [[User: Yoann|Yoann]] || yoann
|-
| Bernie Purcel || ? || bitmap || ? || ?
|-
| Jean-Paul Saman || jpsaman || jpsaman || [[User: jpsaman|jpsaman]] || jpsaman
|-
| Clément Stenac || zorglub || zorglub || ? || ?
|-
| Olivier Teulière || ipkiss || ipkiss || [[User:Ipkiss|Ipkiss]] || ipkiss
|}

VideoLAN Team

2010-02-14T11:28:32Z

Sam Hocevar: my wiki login

This page is intended to help to know who's who.

You don't have to have a SVN write access to put your name here. If you hang out frequently on irc or on the forum write your name here.

(should probably be merged with http://www.videolan.org/team/index.html )

'' You can add yourself to the list following alphabetical order.''

{|
|+ VideoLAN Team
! align=left width=200 | Real name !! align=left width=100 | IRC Nick !!align=left width=100| SVN login !! align=left width=100 | wiki login !!align=left width=100 | Forum login !!
|-
| Filippo Carone || littlejohn || littlejohn || ? || ?
|-
| Rafaël Carré || funman || funman || [[User:Funman|Funman]] || funman
|-
| Antoine Cellerier || dionoea || dionoea || [[User:Dionoea|Dionoea]] || dionoea
|-
| Jerome Decoodt || DiDjCodt || djc || ? || ?
|-
| Rémi Denis-Courmont || courmish || courmish || [[User:Courmisch|Courmisch]] || Rémi Denis-Courmont
|-
| Pierre d'Herbemont || pdherbemont || pdherbemont || [[User:Pdherbemont|Pdherbemont]] || pdherbemont
|-
| Damien Fouilleul || Quovodis || damienf || [[User: Quovodis|Quovodis]] || ?
|-
| Sam Hocevar || sam || sam || [[User:Sam Hocevar]] ||
|-
| Jean-Baptiste Kempf || j-b || jb || [[User:J-b|J-b]] || j-b
|-
| Pavlov Konstantin || thresh || thresh || [[User: Thresh|Thresh]] || thresh
|-
| Felix Paul Kühne || feepk || fkuehne || [[User:Fkuehne|Fkuehne]] || feepk
|-
| Christophe Massiot || Meuuh || meuuh || ? || ?
|-
| Christophe Mutricy || xtophe || xtophe || ? || ?
|-
| Ilkka Ollakka || ILEoo || ileoo || ? || ?
|-
| Faustino Osuna || riquedafreak || riquedafreak || [[User:Riquedafreak|Riquedafreak]] || riquedafreak
|-
| Yoann Peronneau || yoannp || yoann || [[User: Yoann|Yoann]] || yoann
|-
| Bernie Purcel || ? || bitmap || ? || ?
|-
| Jean-Paul Saman || jpsaman || jpsaman || [[User: jpsaman|jpsaman]] || jpsaman
|-
| Clément Stenac || zorglub || zorglub || ? || ?
|-
| Olivier Teulière || ipkiss || ipkiss || [[User:Ipkiss|Ipkiss]] || ipkiss
|}

Git

2009-07-18T11:32:32Z

Sam Hocevar: /* Getting VLC or x264 source code via Git */

= Basic Git usage =

If you are using '''Windows''', please read the [[Git_Windows]] page.

== Getting VLC or x264 source code via Git ==

$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/.

$ git clone git://git.videolan.org/x264.git
Voilà! The full x264 history should be on your hard disk in x264/.

If you want only the last 3 VLC revisions:
$ git clone git://git.videolan.org/vlc.git --depth 3

You can also clone using http with our repo.or.cz mirror.
$ git clone http://repo.or.cz/r/vlc.git

$ git log
to see the full log of the trunk.
$ gitk
to see the log graphically.

You can also browse the sources via [http://git.videolan.org/ gitweb].

== Configure your global git config ==
May need to use
$ git repo-config {various options}
1.4.4.2 Requires the repo-config command rather than just config

=== Personal Information ===
Tell git your name. (use mostly by git-commit)
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

=== Using git with color (Tip) ===
If you want to use git with colored output use:
$ git config --global color.ui true

If you are using an old git version (prior to 1.5.5) and previous command didn't work, use:
$ git config --global color.diff auto
$ git config --global color.status auto
$ git config --global color.branch auto

=== Setting up "git up" (Tip) ===
If you want to be able to just keep in sync using "git up" use:
$ git config --global alias.up "pull --rebase"
And if you like your tree to be messy and don't want git to complain (like in svn) use:
$ git config --global alias.up '!sh -c "git commit -a -m "Before rebase" && git pull --rebase && git reset head^"'

=== Setting up "git wu" (Git What's Up) (Tip) ===
If you want to see what you are about to "git push":
$ git config --global alias.wu "log --stat origin..@{0}"
Now use:
$ git wu

=== Setting up "git wup" (Git What's Up - with patch) (Tip) ===
If you want to see what you are about to "git push", along with the diff:
$ git config --global alias.wup "log -p origin..@{0}"
Now use:
$ git wup

== General GIT Workflow ==
1. Make your file edits in your local repository.

2. "git commit" the changes in your local repository

3. "git pull --rebase" or "git up" (if you did ''git config --global alias.up "pull --rebase"'') to bring the rest of your local repository up to date

4. "git log origin..master" to check what you are going to commit

4. "git push" to move your changes up to the master

"git stash" if you want to "hide" your changes. Do this if you think there may be other commits against the same things you are working on and want to refresh your local checkout (using a git pull --rebase) from the master. Use "git stash apply" to get your stash back.

"git checkout -f master" if you think your tree is pretty hopeless, need a kill-and-fill to bring the master into your local repository.

== List the local branch ==
You can now list your local branch by doing
$ git branch
which should ouput
$ git branch
* master

== List your local non committed changes ==
$ git status | less

== Commit ==
Now you can start to work on your tree. As soon as you feel you have reached a step in developement where you can commit your work '''locally''', use
$ git commit -a
or
$ git commit <specific files>

If you wish to give credit to someone else's work (e.g. you are applying a third party patch):
$ git commit <specific files> --author "Name Surname <user@domain.com>"

== List your commits ==
$ git log

== Keeping your local working branch in sync ==
$ git pull --rebase

To shorten up that command type
$ git config --global alias.up "pull --rebase"

Now you can just type:
$ git up

== Use a graphical interface ==
$ gitk # Tree Browser
$ qgit # Tree Browser
$ git-gui # Commit/push/... editor

== Submitting patches to the vlc-devel or x264-devel ==

First make sure you have '''read''' our [[Sending Patches]] page. And that you've '''read''' the [[Sending Patches#Check_List| Check List]].

If you have been developing on vlc locally and (still) don't have write access, you can submit all your commits in one shot using:
$ rm -Rf patches
$ git format-patch -o patches origin
$ git-send-email --to vlc-devel@videolan.org patches
If you have multiple patch consider using:
$ git-send-email --compose --no-chain-reply-to --to vlc-devel@videolan.org patches
This will produce the patches for each local commit in the directory "patches" and send them.
Use --no-chain-reply-to make sure it doesn't reply.

For x264, do the same with x264-devel@videolan.org


Don't do:
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...
But do:
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

= Advanced usage =
== Creating a secondary local branch ==
If you want to work on a specific project that could require a branch of the trunk, create a local branch of the current branch by doing:
$ git branch mywork
and to actually use it do:
$ git checkout mywork
Which could be summarized by:
$ git checkout -b mywork

Then do some commit on it... And you can go back to your original master branch by doing:
$ git checkout master

== Fetching a remote branch ==
To see the remote branch use:
$ git branch -r
If the remote branch is named 0.8.6-bugfix
$ git branch 0.8.6-bugfix origin/0.8.6-bugfix
Branch 0.8.6-bugfix set up to track remote branch refs/remotes/origin/0.8.6-bugfix.
$ git branch
0.8.6-bugfix
* master
To checkout that branch use:
$ git checkout 0.8.6-bugfix
To stay up-to-date a simple
$ git pull --rebase
Should be enough.

If warnings appear that files still need updating:
$ include/libvlc_internal.h: needs update
include/mediacontrol_internal.h: needs update
include/vlc/libvlc.h: needs update
include/vlc_update.h: needs update
modules/access/mms/mms.c: needs update
...

Then do a checkout -f to revert non committed local changes
$ git checkout -f

To stay up-to-date another
$ git pull --rebase
Should give no more warnings.

To push to the remote branch, use:
$git push origin 0.8.6-bugfix:0.8.6-bugfix

== Creating a remote branch ==
If the new remote branch is named 0.9.0-bugfix, and is based on the local master branch.
First make sure everything go as planned with the --dry-run option:
$ git push --dry-run origin master:refs/heads/0.9.0-stable
To git@git.videolan.org:vlc.git
* [new branch] master -> 0.9.0-stable

Then push it:
$ git push origin master:refs/heads/0.9.0-stable
To git@git.videolan.org:vlc.git
* [new branch] master -> 0.9.0-stable
$ git branch -r
origin/0.9.0-stable
origin/master

To checkout that branch now see ''Fetching a remote branch''

== Publishing your own fork ==
Goto [http://repo.or.cz/w/vlc.git http://repo.or.cz/w/vlc.git] and click [http://repo.or.cz/m/regproj.cgi?name=vlc/ fork]. You will be able to publish your work there.

Please don't forget to send a mail to the vlc-devel as soon as you create your fork.

== Revert your non-committed local changes ==
$ git checkout -f

==Edit or undo not yet pushed commits ==
This will undo the last commit
$ git reset HEAD^
which is the same as
$ git reset master^
(if your checked-out copy of your tree is master)
And also the same as
$ git reset a44a594 # note that there is no need to use the full sha id

If you have a stack of patch that you have not yet committed you can delete one patch from the list using git rebase --interactive
$ git rebase --interactive origin
pick eacf185 test
pick 56322eb VLMA owner is vlma prod.

# Rebase 826757e..56322eb onto 826757e
#
# Commands:
# pick = use commit
# edit = use commit, but stop for amending
# squash = use commit, but meld into previous commit

== Diff-ing ==
* You can diff between two branches using
$ git diff branch1 branch2
* You can diff between the previous 10th commit and current using
$ git diff HEAD~10 HEAD
* You can diff between the previous 10th commit and current of the branch "mywork" using
$ git diff mywork~10 mywork
* Imagine that git log is like
$ git log
commit e0394f269305edd09843257e7c1d1a66aaf48ab3
Author: jb <jb>
Date: Fri Apr 13 07:14:48 2007 +0000
qt4 - Mousewheel (2)
commit e80b339081aa6755f67c9bd8e2aacf93a9a79d95
[..]
commit ff7004b70fd239e4120deb160e2991bd5237b8df
[..]
commit a44a594898f981a145cfcace5f16f8973f9eb46f
[..]
commit 690df705c963cf6bf6f5746d54bc97a85ff91919
[..]
commit 679f8b1c3e0baa469efa970588b95a625c595d64
[..]

$ git diff a44a594898f981a145cfcace5f16f8973f9eb46f~2 e80b339081aa6755f67c9bd8e2aacf93a9a79d95
Will be equivalent to:
$ git diff ff7004b70fd239e4120deb160e2991bd5237b8df e80b339081aa6755f67c9bd8e2aacf93a9a79d95
And to:
$ git diff HEAD~4 HEAD^

* Remember that to produce a patch you should rather use git-format-patch than git-diff most of the time.

== Patch-ing ==
* You can apply patches using
$ git apply <patch>

== Tracking regression ==
git has a great tool called [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect] to help you to track a faulty commit. Imagine you are tracking a bug that is known to appear after 0.8.6 (assuming 0.8.6 is tagged):
$ git bisect start
$ git bisect bad # tell git current version has the bug you are tracking
$ git bisect good 0.8.6 # tell git 0.8.6 didn't has the bug
And then git will checkout a certain revision, and ask you to test it. And you simply say whether this version has the bug.
If it has the bug:
$ git bisect bad
if the bug is not present:
$ git bisect good
And so on by bisection... At the end git will indicate the faulty commit. Most of the time this tool is really efficient to track regression.

If you can provide a script that test the presence of the bug
$ git bisect run <script_name>
will be able to track down the regression by itself. See [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect Documentation].

= Using Git to push to VideoLAN git =
== Initial requirement ==
* Make sure you've set your name and email in your commits
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

== Convert your tree to use your ssh push commit access ==
$ vi vlc/.git/config
And replace git://git.videolan.org/vlc.git by git@git.videolan.org:vlc.git

== Staying up to date ==
$ git pull --rebase

If you don't want to have to type --rebase everytime you pull do:
$ git config branch.master.rebase true

This one creates a merge object which is not how SVN worked, so let's use the first version...
$ git pull

== Pushing your work ==
$ git log origin..master # Check what you are going to push
$ git push



= Documentation about git =
* [http://git.or.cz/ Official Git Website]
* [http://www.kernel.org/pub/software/scm/git/docs/tutorial.html Git Tutorial]
* [http://git.or.cz/course/svn.html Switching from SVN to git using cogito]
* [http://wiki.sourcemage.org/Git_Guide Very good Git guide]

[[Category:Building]]

LibVLC SampleCode SDL

2008-03-21T23:14:12Z

Sam Hocevar: cool libSDL/libVLC example

This sample code will render a video into an SDL surface.

'''NOTE''': this requires the "vmem" video output which was checked in on March 21st, 2008.

<pre>
/* libSDL and libVLC sample code
* Copyright © 2008 Sam Hocevar <sam@zoy.org>
* license: [http://en.wikipedia.org/wiki/WTFPL WTFPL] */

#include <stdio.h>
#include <stdint.h>
#include <math.h>
#include <stdlib.h>

#include <SDL.h>
#include <SDL_mutex.h>

#include <vlc/libvlc.h>

#define WIDTH 640
#define HEIGHT 480

#define VIDEOWIDTH 320
#define VIDEOHEIGHT 240

struct ctx
{
SDL_Surface *surf;
SDL_mutex *mutex;
};

static void catch (libvlc_exception_t *ex)
{
if(libvlc_exception_raised(ex))
{
fprintf(stderr, "exception: %s\n", libvlc_exception_get_message(ex));
exit(1);
}

libvlc_exception_clear(ex);
}

static void * lock(struct ctx *ctx)
{
SDL_LockMutex(ctx->mutex);
SDL_LockSurface(ctx->surf);
return ctx->surf->pixels;
}

static void unlock(struct ctx *ctx)
{
/* VLC just rendered the video, but we can also render stuff */
uint16_t *pixels = (uint16_t *)ctx->surf->pixels;
int x, y;

for(y = 10; y < 40; y++)
for(x = 10; x < 40; x++)
if(x < 13 || y < 13 || x > 36 || y > 36)
pixels[y * VIDEOWIDTH + x] = 0xffff;
else
pixels[y * VIDEOWIDTH + x] = 0x0;

SDL_UnlockSurface(ctx->surf);
SDL_UnlockMutex(ctx->mutex);
}

int main(int argc, char *argv[])
{
char clock[64], cunlock[64], cdata[64];
char width[32], height[32], pitch[32];
libvlc_exception_t ex;
libvlc_instance_t *libvlc;
libvlc_media_descriptor_t *md;
libvlc_media_instance_t *mi;
char const *vlc_argv[] =
{
"-q",
//"-vvvvv",
"--plugin-path", VLC_TREE "/modules",
"--noaudio",
"--vout", "vmem",
"--vmem-width", width,
"--vmem-height", height,
"--vmem-pitch", pitch,
"--vmem-chroma", "RV16",
"--vmem-lock", clock,
"--vmem-unlock", cunlock,
"--vmem-data", cdata,
};
int vlc_argc = sizeof(vlc_argv) / sizeof(*vlc_argv);

SDL_Surface *screen, *empty;
SDL_Event event;
SDL_Rect rect;
int done = 0, action = 0, pause = 0, n = 0;

struct ctx ctx;

/*
* Initialise libSDL
*/
if(SDL_Init(SDL_INIT_VIDEO | SDL_INIT_EVENTTHREAD) == -1)
{
printf("cannot initialize SDL\n");
return EXIT_FAILURE;
}

empty = SDL_CreateRGBSurface(SDL_SWSURFACE, VIDEOWIDTH, VIDEOHEIGHT,
32, 0, 0, 0, 0);
ctx.surf = SDL_CreateRGBSurface(SDL_SWSURFACE, VIDEOWIDTH, VIDEOHEIGHT,
16, 0x001f, 0x07e0, 0xf800, 0);

ctx.mutex = SDL_CreateMutex();

int options = SDL_ANYFORMAT | SDL_HWSURFACE | SDL_DOUBLEBUF;

screen = SDL_SetVideoMode(WIDTH, HEIGHT, 0, options);
if(!screen)
{
printf("cannot set video mode\n");
return EXIT_FAILURE;
}

/*
* Initialise libVLC
*/
sprintf(clock, "%lld", (long long int)(intptr_t)lock);
sprintf(cunlock, "%lld", (long long int)(intptr_t)unlock);
sprintf(cdata, "%lld", (long long int)(intptr_t)&ctx);
sprintf(width, "%i", VIDEOWIDTH);
sprintf(height, "%i", VIDEOHEIGHT);
sprintf(pitch, "%i", VIDEOWIDTH * 2);

if(argc < 2)
{
printf("too few arguments (MRL needed)\n");
return EXIT_FAILURE;
}
libvlc_exception_init(&ex);
libvlc = libvlc_new(vlc_argc, vlc_argv, &ex);
catch(&ex);
md = libvlc_media_descriptor_new(libvlc, argv[1], &ex);
catch(&ex);
mi = libvlc_media_instance_new_from_media_descriptor(md, &ex);
catch(&ex);
libvlc_media_descriptor_release(md);

libvlc_media_instance_play(mi, &ex);
catch(&ex);

/*
* Main loop
*/
rect.w = 0;
rect.h = 0;

while(!done)
{
action = 0;

/* Keys: enter (fullscreen), space (pause), escape (quit) */
while( SDL_PollEvent( &event ) )
{
switch(event.type)
{
case SDL_QUIT:
done = 1;
break;
case SDL_KEYDOWN:
action = event.key.keysym.sym;
break;
}
}

switch(action)
{
case SDLK_ESCAPE:
done = 1;
break;
case SDLK_RETURN:
options ^= SDL_FULLSCREEN;
screen = SDL_SetVideoMode(WIDTH, HEIGHT, 0, options);
break;
case ' ':
pause = !pause;
break;
}

rect.x = (int)((1. + .5 * sin(0.03 * n)) * (WIDTH - VIDEOWIDTH) / 2);
rect.y = (int)((1. + .5 * cos(0.03 * n)) * (HEIGHT - VIDEOHEIGHT) / 2);

if(!pause)
n++;

/* Blitting the surface does not prevent it from being locked and
* written to by another thread, so we use this additional mutex. */
SDL_LockMutex(ctx.mutex);
SDL_BlitSurface(ctx.surf, NULL, screen, &rect);
SDL_UnlockMutex(ctx.mutex);

SDL_Flip(screen);
SDL_Delay(10);

SDL_BlitSurface(empty, NULL, screen, &rect);
}

/*
* Stop stream and clean up libVLC
*/
libvlc_media_instance_stop(mi, &ex);
catch(&ex);

libvlc_media_instance_release(mi);
libvlc_release(libvlc);

/*
* Close window and clean up libSDL
*/
SDL_DestroyMutex(ctx.mutex);
SDL_FreeSurface(ctx.surf);
SDL_FreeSurface(empty);

SDL_Quit();

return 0;
}
</pre>

LibVLC

2008-03-21T22:33:20Z

Sam Hocevar: /* Sample Code */

{{Lowercase}}
You can embed libVLC into your application to gain audio/video playing features.

== Tutorials ==
Here are three different tutorials on libVLC:
* [[LibVLC_Visual_C++| Visual C++ Tutorial]] '' (uses "old" legacy API) ''
* [[LibVLC_Tutorial_086c| Tutorial for version 0.8.6c]]
* [[LibVLC_Tutorial|Tutorial for trunk version]]

== Sample Code ==
* [[LibVLC_SampleCode_Thumbnailer|Generate thumbnails using LibVLC]]
* [[LibVLC_SampleCode_SDL|Use LibVLC in an SDL application]]

== Documentation ==
* The documentation on the external API is here: [[ExternalAPI]]
This applies to current trunk version:
* On Mac OS X there you can use libvlc through some Objective-C class using the [[Mac OS X Framework]].
* Currently it exists Java, Python and .NET bindings around LibVLC.
* [[LibVLC_Memory_Management| LibVLC Memory Management]] explained. It covers the basics on the _new(), _retain(), _release().
* [[LibVLC_Media_List_Management| LibVLC Media List Management]] explained. It covers the basics on how to set up a list of media or a playlist.

Git

2007-11-04T12:18:41Z

Sam Hocevar: /* Initial checkout */

For your convenience, a git mirror of the VLC svn tree has been set up. Here is a tutorial on how to use the git VLC repository.

You can read more about the VLC svn tree on our [[Subversion| Subversion wiki page]].

= Basic Git usage =
== Getting VLC source code via Git ==
$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/. Type
$ git log
to see the full log of the trunk.
$ gitk
to see the log graphically.

You can also browse the sources via [http://git.videolan.org/cgi-bin/gitweb.cgi gitweb].

== Configure your local git repository ==
Tell git your name. (use mostly by git-commit)
$ git repo-config user.name "Your Name"
$ git repo-config user.email "me@example.com"

== List the local branch ==
You can now list your local branch by doing
$ git branch
which should ouput
$ git branch
* master

== List your local non committed changes ==
$ git status | less

== Commit ==
Now you can start to work on your tree. As soon as you feel you've reached a step in developement you can commit '''locally''' your work by
$ git commit -a
or
$ git commit <specific files>

== List your commits ==
$ git log

== Keeping your local working branch in sync ==
$ git fetch origin
$ git rebase origin
voilà! Your commit will be re-applied on top of the origin (the svn trunk).

== Submitting patches to the vlc-devel ==
If you have been developing on vlc locally and (still) don't have write access, you can submit all your commit in one shot using:
$ git format-patch -o out origin
which will produce the patches for each local commit in the directory "out".
You can also use the [http://www.kernel.org/pub/software/scm/git/docs/git-imap-send.html git-imap-send] command:
$ git format-patch --stdout --attach -n origin | git-imap-send
which will directly produces the emails and store them in a imap mail box, provided that you have properly set up [http://www.kernel.org/pub/software/scm/git/docs/git-imap-send.html git-imap-send].

= Advanced usage =
== Creating a secondary local branch ==
If you want to work on a specific project that could require a branch of the trunk, create a local branch of the current branch by doing:
$ git branch mywork
and to actually use it do:
$ git checkout mywork
Which could be summarized by:
$ git checkout -b mywork

Then do some commit on it... And you can go back to your original master branch by doing:
$ git checkout master

== Fetching a remote branch ==
If the remote branch is named avacore_branch
$ git checkout origin/avacore_branch
To stay up-to-date a simple
$ git fetch
Should be enough.

== Revert your non-committed local changes ==
$ git checkout -f

==Undo commit ==
This will undo the last commit
$ git reset HEAD^
which is the same as
$ git reset master^
(if you are checked-out copy of your tree is master)
And also the same as
$ git reset a44a594 # note that there is no need to use the full sha id
if you have:
$ git log
commit ff7004b70fd239e4120deb160e2991bd5237b8df
Author: fkuehne <fkuehne>
Date: Thu Apr 12 18:44:47 2007 +0000
* added sanity flags for future darwin releases and potentionally fixed OSX
commit a44a594898f981a145cfcace5f16f8973f9eb46f
Author: jb <jb>
Date: Thu Apr 12 16:24:49 2007 +0000
Qt4 - MouseWheel support - patch by Sergey Volk.

== Diff-ing ==
* You can diff between two branches using
$ git diff branch1 branch2
* You can diff between the previous 10th commit and current using
$ git diff HEAD~10 HEAD
* You can diff between the previous 10th commit and current of the branch "mywork" using
$ git diff mywork~10 mywork
* Imagine that git log is like
$ git log
commit e0394f269305edd09843257e7c1d1a66aaf48ab3
Author: jb <jb>
Date: Fri Apr 13 07:14:48 2007 +0000
qt4 - Mousewheel (2)
commit e80b339081aa6755f67c9bd8e2aacf93a9a79d95
[..]
commit ff7004b70fd239e4120deb160e2991bd5237b8df
[..]
commit a44a594898f981a145cfcace5f16f8973f9eb46f
[..]
commit 690df705c963cf6bf6f5746d54bc97a85ff91919
[..]
commit 679f8b1c3e0baa469efa970588b95a625c595d64
[..]

$ git diff a44a594898f981a145cfcace5f16f8973f9eb46f~2 e80b339081aa6755f67c9bd8e2aacf93a9a79d95
Will be equivalent to:
$ git diff ff7004b70fd239e4120deb160e2991bd5237b8df e80b339081aa6755f67c9bd8e2aacf93a9a79d95
And to:
$ git diff HEAD~4 HEAD^

* Remember that to produce a patch you should rather use git-format-patch than git-diff most of the time.

== Tracking regression ==
git has a great tool called [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect] to help you to track a faulty commit. Imagine you are tracking a bug that is known to appear after 0.8.6 (assuming 0.8.6 is tagged):
$ git bisect start
$ git bisect bad # tell git current version has the bug you are tracking
$ git bisect good 0.8.6 # tell git 0.8.6 didn't has the bug
And then git will checkout a certain revision, and ask you to test it. And you simply say whether this version has the bug.
If it has the bug:
$ git bisect bad
if the bug is not present:
$ git bisect good
And so on by bisection... At the end git will indicate the faulty commit. Most of the time this tool is really efficient to track regression.

If you can provide a script that test the presence of the bug
$ git bisect run <script_name>
will be able to track down the regression by itself. See [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect Documentation].

= Using Git (and git-svn) to commit on VideoLAN svn trunk =
== Initial checkout ==
First get the official VLC svn trunk within git
$ git-svn init svn://your_committer_login@svn.videolan.org/vlc
If you want the full history skip this step:
$ git-svn fetch -r19800
Now get the get the rest
$ git-svn fetch
Compress the tree:
$ git repack -d

== Keeping in sync ==
$ git-svn fetch
$ git rebase

== Commit to VLC svn through git-svn ==
Once you've locally committed your changes you should be able to commit them to the remote svn branch by doing:
$ git-svn dcommit

Note that with git-svn, you'll lost some of the git advantages, and it will probably introduce some overhead in some cases.

= Using Git to publish your work (for SoC student?) =
First get the official VLC '''Soc''' trunk
$ git clone git://git.videolan.org/vlc-soc.git
$ cd vlc-soc
Ask for write access to a branch (called your_name_branch). Now we will make git know that you want to publish on this branch
$ git config remote.my_soc_public_branch.url ssh://your_name@altair.videolan.org/home/videolan/gitroot/vlc-soc.git
Now tell git that you want to automatically push the local master branch to the public your_name_branch:
$ git config remote.my_soc_public_branch.push +master:your_name_branch # the "+" will tell git to force update ignoring conflicts

Do some work and commit it to your master branch.
$ git commit -a
You can also sync with the trunk (origin) as needed
$ git fetch origin
$ git rebase origin
And don't forget to publish your changes:
$ git push my_soc_public_branch
Now you should be able to see your latest changes in your branch via [http://git.videolan.org/cgi-bin/gitweb.cgi gitweb].

= Documentation about git =
* [http://git.or.cz/ Official Git Website]
* [http://www.kernel.org/pub/software/scm/git/docs/tutorial.html Git Tutorial]
* [http://git.or.cz/course/svn.html Switching from SVN to git using cogito]

[[Category:Building]]

User:Sam Hocevar

2005-06-23T20:40:39Z

Sam Hocevar:

Hi! I am a [[VLC]] developer, currently not very active.