X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=HACKING;h=80382ed4ea71d7e91b79ec4c2d74e78d3903f333;hb=7d0b729a491d0ee388cf3d0a73b87cd2f506c314;hp=221bfed252e851c0101b65f373c47fc281a901d8;hpb=76a376b0671b6e791ee3b5aa859e3f2dabd7bcd1;p=platform%2Fupstream%2Fconnman.git diff --git a/HACKING b/HACKING index 221bfed..80382ed 100644 --- a/HACKING +++ b/HACKING @@ -46,7 +46,7 @@ So the normal steps to checkout, build and install such a repository is like this: Checkout repository - # git-clone git://git.moblin.org/projects/connman.git + # git clone git://git.kernel.org/pub/scm/network/connman/connman.git # cd connman Configure and build @@ -77,7 +77,12 @@ to use "make install" when testing "connmand". The "bootstrap-configure" automatically includes this option. Run daemon in foreground with debugging - # sudo ./src/connmand -n -d + # sudo ./src/connmand -n -d 'plugins/*' + +The debugging option -d takes an argument. This argument can be a comma +separated list of file names like 'plugins/wifi.c,plugins/ethernet.c' to +enable debugs in these files. Simple glob style pattern matching is +supported in this list. For production installations or distribution packaging it is important that the "--enable-maintainer-mode" option is NOT used. @@ -90,33 +95,15 @@ line switch allows to specify a glob pattern for the interface names. # sudo ./src/connmand -n -i wlan* -Generating source code documentation -==================================== - -The source code is annotated using the gtk-doc style documentation. This -allows an easy way of generating API documentation. The "bootstrap-configure" -script will use the "--enable-gtk-doc" configure to enable the generation of -the documentation. - -To make the gtk-doc process work, the gtk-doc tools need to be installed. -Every distribution should provide a package for this, but the naming of the -package might be different: - - Ubuntu/Debian - # apt-get install gtk-doc-utils - - Fedora - # yum install gtk-doc - -In case "bootstrap-configure" is not used, the manual steps for generating -the documentation files are like this: - - Configuring the repository - # ./configure --enable-gtk-doc - - Generate the documentation - # cd doc && make +Debugging the D-Bus interface during runtime +============================================ - View documentation - # firefox doc/html/index.html +Running the daemon with debugging information in the foreground is quite +verbose and sometimes not really helpful. The "monitor-connman" script +allows to monitor "PropertyChanged" D-Bus signals from various interfaces. +Every "PropertyChanged" signal will generate a line of output. Some of them +can get very complex. The first detail inside "{ ... }" is the interface +name (without its service name prefix). The second detail inside "[ ... ]" +is the object path. And after that it is followed by a key and value of +the property that changed.