How to begin contributing to XWidgets for GSoC

How to begin contributing to XWidgets for GSoC

[Daniil Plyukhin]

[-- Attachment #1: Type: text/plain, Size: 343 bytes --]

Hi,

I'd like to contribute to Emacs for this year for GSoC, working on the XWidgets project.

I figure the best way to show that I'm capable of taking this on is by beginning some work on my own, so could you give me some pointers as to where I can start, and possibly some relevant reading material?


Eager to help!

Dan Plyukhin

[-- Attachment #2: Type: text/html, Size: 3181 bytes --]

Re: How to begin contributing to XWidgets for GSoC

[joakim]

Daniil Plyukhin <d.plyukhin@mail.utoronto.ca> writes:

> Hi,
>
> I'd like to contribute to Emacs for this year for GSoC, working on the
> XWidgets project. 
>
> I figure the best way to show that I'm capable of taking this on is by
> beginning some work on my own, so could you give me some pointers as
> to where I can start, and possibly some relevant reading material?

Thanks for showing interest in the Emacs Xwidget project!
I'm the maintainer of the branch.

The current readme lives here:
http://www.verona.se/projects/xwidget-emacs.html

I think the best approach is to just start building and testing on your
plattform.

I use Fedora 20, but the code has been reported to work on many other
GNU/Linux projects.

I think this years focus should be on getting merged to the Emacs trunk
when it opens again.

>
> Eager to help!
>
> Dan Plyukhin
>
>

-- 
Joakim Verona

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

joakim@verona.se writes:
> I'm the maintainer of the branch.
>
> The current readme lives here:
> http://www.verona.se/projects/xwidget-emacs.html
>
> I think the best approach is to just start building and testing on your
> plattform.
>
> I use Fedora 20, but the code has been reported to work on many other
> GNU/Linux projects.
>
> I think this years focus should be on getting merged to the Emacs trunk
> when it opens again.

I'm also interested in this project.  I just checked out the `xwidget'
branch and tried to build it.  But:

--8<---------------cut here---------------start------------->8---
xwidget.c:95:26: fatal error: girepository.h: No such file or directory
 #include <girepository.h>
                          ^
compilation terminated.
make[2]: *** [xwidget.o] Error 1
make[2]: Leaving directory `/home/xfq/emacs-repo/main/xwidget/src'
make[1]: *** [src] Error 2
make[1]: Leaving directory `/home/xfq/emacs-repo/main/xwidget'
make: *** [bootstrap] Error 2
--8<---------------cut here---------------end--------------->8---

The same error occured after installing the following packages in Ubuntu
repo:

* gobject-introspection
* libgirepository-1.0-1
* libgirepository1.0-dev
* gir1.2-freedesktop

Any ideas?

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[Daimrod]

Xue Fuqiao <xfq@gnu.org> writes:

> joakim@verona.se writes:
>> I'm the maintainer of the branch.
>>
>> The current readme lives here:
>> http://www.verona.se/projects/xwidget-emacs.html
>>
>> I think the best approach is to just start building and testing on your
>> plattform.
>>
>> I use Fedora 20, but the code has been reported to work on many other
>> GNU/Linux projects.
>>
>> I think this years focus should be on getting merged to the Emacs trunk
>> when it opens again.
>
> I'm also interested in this project.  I just checked out the `xwidget'
> branch and tried to build it.  But:
>
> xwidget.c:95:26: fatal error: girepository.h: No such file or directory
>  #include <girepository.h>
>                           ^
> compilation terminated.
> make[2]: *** [xwidget.o] Error 1
> make[2]: Leaving directory `/home/xfq/emacs-repo/main/xwidget/src'
> make[1]: *** [src] Error 2
> make[1]: Leaving directory `/home/xfq/emacs-repo/main/xwidget'
> make: *** [bootstrap] Error 2
>
> The same error occured after installing the following packages in Ubuntu
> repo:
>
> * gobject-introspection
> * libgirepository-1.0-1
> * libgirepository1.0-dev
> * gir1.2-freedesktop
>
> Any ideas?

That's weird, the file should be provided by the package
libgirepository1.0-dev. Does the file appear in:
$ dpkg -L libgirepository1.0-dev | grep girepository.h
?

Best,
-- 
Daimrod/Greg

Re: How to begin contributing to XWidgets for GSoC

[joakim]

Daimrod <daimrod@gmail.com> writes:

> Xue Fuqiao <xfq@gnu.org> writes:
>
>> joakim@verona.se writes:
>>> I'm the maintainer of the branch.
>>>
>>> The current readme lives here:
>>> http://www.verona.se/projects/xwidget-emacs.html>>
>>> I think the best approach is to just start building and testing on your
>>> plattform.
>>>
>>> I use Fedora 20, but the code has been reported to work on many other
>>> GNU/Linux projects.
>>>
>>> I think this years focus should be on getting merged to the Emacs trunk
>>> when it opens again.
>>
>> I'm also interested in this project.  I just checked out the `xwidget'
>> branch and tried to build it.  But:
>>
>> xwidget.c:95:26: fatal error: girepository.h: No such file or directory
>>  #include <girepository.h>
>>                           ^
>> compilation terminated.
>> make[2]: *** [xwidget.o] Error 1
>> make[2]: Leaving directory `/home/xfq/emacs-repo/main/xwidget/src'
>> make[1]: *** [src] Error 2
>> make[1]: Leaving directory `/home/xfq/emacs-repo/main/xwidget'
>> make: *** [bootstrap] Error 2
>>
>> The same error occured after installing the following packages in Ubuntu
>> repo:
>>
>> * gobject-introspection
>> * libgirepository-1.0-1
>> * libgirepository1.0-dev
>> * gir1.2-freedesktop
>>
>> Any ideas?
>
> That's weird, the file should be provided by the package
> libgirepository1.0-dev. Does the file appear in:
> $ dpkg -L libgirepository1.0-dev | grep girepository.h
> ?

Another thing, the public repositories are lagging a bit behind my
private repos. I will attempt to push the latest code this week.



> Best,

-- 
Joakim Verona

Re: How to begin contributing to XWidgets for GSoC

[joakim]

joakim@verona.se writes:

> Another thing, the public repositories are lagging a bit behind my
> private repos. I will attempt to push the latest code this week.


See https://gitorious.org/emacs-xwidgets/emacs-xwidgets/source/39adb3f2f911a7c4fc6ab65ce5acc369e877741a:

The branch name is xwidget2. Gitorious seems to get upset if there is no
master branch. I hope you are able to use this repo anyway.

For various reasons the xwidget branch repo management has been problematic.
I will write a novella about it.

Dont expect this gitorious repo to be permanent in anyway. On the plus
side, my local branch of this repo is merged and built from trunk
everyday, and its my primary emacs.

>
>
>
>> Best,

-- 
Joakim Verona

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

joakim@verona.se writes:
> See https://gitorious.org/emacs-xwidgets/emacs-xwidgets/source/39adb3f2f911a7c4fc6ab65ce5acc369e877741a:

I can't successfully clone this repo:

  $ git clone https://git.gitorious.org/emacs-xwidgets/emacs-xwidgets.git
  Cloning into 'emacs-xwidgets'...
  remote: Counting objects: 716588, done
  remote: Finding sources: 100% (716588/716588)
  remote: Compressing objects: 100% (9874/9874)
  remote: Compressing objects: 100% (9845/9845)
  Receiving objects: 100% (716588/716588), 227.22 MiB | 218.00 KiB/s, done.
  Resolving deltas: 100% (577228/577228), done.
  Checking connectivity... done
  warning: remote HEAD refers to nonexistent ref, unable to checkout.

So, perhaps a `master' branch is necessary[fn:1].

BTW I (finally) built the `xwidget' branch from Savannah successfully.
The command `xwidget-webkit-browse-url' looks cool.  I'll start to test
it more extensively and dive into src/*.[ch] later.

Footnotes:

[fn:1] http://www.linux-pages.com/2013/01/git-clone-gives-warning-remote-head-refers-to-nonexistent-ref-unable-to-checkout/

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[joakim]

Xue Fuqiao <xfq@gnu.org> writes:

> joakim@verona.se writes:
>> See https://gitorious.org/emacs-xwidgets/emacs-xwidgets/source/39adb3f2f911a7c4fc6ab65ce5acc369e877741a:
>
> I can't successfully clone this repo:
>
>   $ git clone https://git.gitorious.org/emacs-xwidgets/emacs-xwidgets.git
>   Cloning into 'emacs-xwidgets'...
>   remote: Counting objects: 716588, done
>   remote: Finding sources: 100% (716588/716588)
>   remote: Compressing objects: 100% (9874/9874)
>   remote: Compressing objects: 100% (9845/9845)
>   Receiving objects: 100% (716588/716588), 227.22 MiB | 218.00 KiB/s, done.
>   Resolving deltas: 100% (577228/577228), done.
>   Checking connectivity... done
>   warning: remote HEAD refers to nonexistent ref, unable to checkout.
>
> So, perhaps a `master' branch is necessary[fn:1].
>
> BTW I (finally) built the `xwidget' branch from Savannah successfully.
> The command `xwidget-webkit-browse-url' looks cool.  I'll start to test
> it more extensively and dive into src/*.[ch] later.

I didnt add a master branch because my git repo uses trunk like bzr.
I used this mirror as a start: http://repo.or.cz/w/emacs.git, which
seems to have a master in sync with trunk.

A large part of this years GSOC will be combatting the DVCSes I think.



>
> Footnotes:
>
> [fn:1] http://www.linux-pages.com/2013/01/git-clone-gives-warning-remote-head-refers-to-nonexistent-ref-unable-to-checkout/

-- 
Joakim Verona

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

joakim@verona.se writes:
>> joakim@verona.se writes:
>>> See https://gitorious.org/emacs-xwidgets/emacs-xwidgets/source/39adb3f2f911a7c4fc6ab65ce5acc369e877741a:
>>
>> I can't successfully clone this repo:
>>
>>   $ git clone https://git.gitorious.org/emacs-xwidgets/emacs-xwidgets.git
>>   Cloning into 'emacs-xwidgets'...
>>   remote: Counting objects: 716588, done
>>   remote: Finding sources: 100% (716588/716588)
>>   remote: Compressing objects: 100% (9874/9874)
>>   remote: Compressing objects: 100% (9845/9845)
>>   Receiving objects: 100% (716588/716588), 227.22 MiB | 218.00 KiB/s, done.
>>   Resolving deltas: 100% (577228/577228), done.
>>   Checking connectivity... done
>>   warning: remote HEAD refers to nonexistent ref, unable to checkout.
>>
>> So, perhaps a `master' branch is necessary[fn:1].
> I didnt add a master branch because my git repo uses trunk like bzr.
> I used this mirror as a start: http://repo.or.cz/w/emacs.git, which
> seems to have a master in sync with trunk.
>
> A large part of this years GSOC will be combatting the DVCSes I think.

I checked out the `xwidget2' branch successfully by `git checkout -b
xwidget2 origin/xwidget2'.  Could you please rename that branch (by `git
branch -m origin/xwidget2 master', perhaps)?

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[Thien-Thi Nguyen]

[-- Attachment #1: Type: text/plain, Size: 566 bytes --]

() Xue Fuqiao <xfq@gnu.org>
() Wed, 05 Mar 2014 20:16:39 +0800

   So, perhaps a `master' branch is necessary[fn:1].

Another way is to do:

 git clone -b xwidget2 URL

in the first place.  To avoid repeating "git clone", maybe one of:

 git remote set-head origin -a
 git remote set-head origin xwidget2

would work, too.

-- 
Thien-Thi Nguyen
   GPG key: 4C807502
   (if you're human and you know it)
      read my lisp: (responsep (questions 'technical)
                               (not (via 'mailing-list)))
                     => nil

[-- Attachment #2: Type: application/pgp-signature, Size: 197 bytes --]

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

Thien-Thi Nguyen <ttn@gnu.org> writes:
>    So, perhaps a `master' branch is necessary[fn:1].
>
> Another way is to do:
>
>  git clone -b xwidget2 URL
>
> in the first place.  To avoid repeating "git clone", maybe one of:
>
>  git remote set-head origin -a
>  git remote set-head origin xwidget2
>
> would work, too.

Thanks.  I'll try.

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

Daimrod <daimrod@gmail.com> writes:
>> I'm also interested in this project.  I just checked out the `xwidget'
>> branch and tried to build it.  But:
>>
>> xwidget.c:95:26: fatal error: girepository.h: No such file or directory
>>  #include <girepository.h>
>>                           ^
>> compilation terminated.
>> make[2]: *** [xwidget.o] Error 1
>> make[2]: Leaving directory `/home/xfq/emacs-repo/main/xwidget/src'
>> make[1]: *** [src] Error 2
>> make[1]: Leaving directory `/home/xfq/emacs-repo/main/xwidget'
>> make: *** [bootstrap] Error 2
>>
>> The same error occured after installing the following packages in Ubuntu
>> repo:
>>
>> * gobject-introspection
>> * libgirepository-1.0-1
>> * libgirepository1.0-dev
>> * gir1.2-freedesktop
>>
>> Any ideas?
>
> That's weird, the file should be provided by the package
> libgirepository1.0-dev. Does the file appear in:
> $ dpkg -L libgirepository1.0-dev | grep girepository.h

Yes:

  $ dpkg -L libgirepository1.0-dev | grep girepository.h
  /usr/include/gobject-introspection-1.0/girepository.h

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[Xue Fuqiao]

`--enable-asserts' was removed on 2012-06-28.  Here's a (very minor)
patch for the build process (although I haven't built it successfully
yet, due to the previously mentioned error):

=== modified file 'README.xwidget'
--- README.xwidget	2013-06-13 07:42:41 +0000
+++ README.xwidget	2014-03-04 08:26:41 +0000
@@ -31,8 +31,9 @@
 #git clone https://github.com/jave/xwidget-emacs.git
 #the below compiler flags shouldn't be strictly necessary
 export CFLAGS=" -g"
-./configure --with-xwidgets --enable-asserts --with-x-toolkit=gtk3
-make -j4
+./autogen.sh
+./configure --with-xwidgets --with-x-toolkit=gtk3
+make bootstrap -j4
 gdb -ex run src/emacs
 
 ** try it out

-- 
http://www.gnu.org/software/emacs/

Re: How to begin contributing to XWidgets for GSoC

[Daimrod]

Daniil Plyukhin <d.plyukhin@mail.utoronto.ca> writes:

> Hi,
>
> I'd like to contribute to Emacs for this year for GSoC, working on the XWidgets project.
>
> I figure the best way to show that I'm capable of taking this on is by
> beginning some work on my own, so could you give me some pointers as
> to where I can start, and possibly some relevant reading material?

IMHO, once you've successfully built emacs-xwidget, you could start by
reading:
1. (info "(elisp) Writing Emacs Primitives")
2. (info "(elisp) Object Internals")
3. some code in src/lisp.h

This will help you to understand how C types and C functions can be
manipulated on the Elisp side.

After that, you will ready to look at xwidget.[ch] and how xwidget hooks
into the display engine.

Tell me if you have any questions.

Best,

-- 
Daimrod/Greg