X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=HACKING;h=80382ed4ea71d7e91b79ec4c2d74e78d3903f333;hb=refs%2Fheads%2Ftizen_5.5_wearable_hotfix;hp=61b9eb396b340d92e75ee30f34fa8810e139f213;hpb=6b32bd46caf32eb26d2706a7655ee66fe6639b3e;p=platform%2Fupstream%2Fconnman.git diff --git a/HACKING b/HACKING index 61b9eb3..80382ed 100644 --- a/HACKING +++ b/HACKING @@ -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. @@ -97,53 +102,8 @@ 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. - During start of daemon - {Manager} [/] Devices = dbus.Array([dbus.ObjectPath('/dev_00_90_CC ... - {Device} [/dev_00_90_CC_xx_xx_xx] Powered = 1 - {Device} [/dev_00_90_CC_xx_xx_xx] Networks = dbus.Array( ... - - During shutdown of daemon - {Device} [/dev_00_90_CC_xx_xx_xx] Networks = dbus.Array( ... - {Device} [/dev_00_90_CC_xx_xx_xx] Powered = 0 - {Manager} [/] Devices = dbus.Array([], ... - 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. - - -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: - - Debian - # apt-get install gtk-doc-tools - - Ubuntu - # 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 - - View documentation - # firefox doc/html/index.html -