User Tools

Site Tools


library-hacking

**This is an old revision of the document!** ----

A PCRE internal error occured. This might be caused by a faulty plugin

======== How to modify / enhance the ROHC library? ======== Follow this procedure in order to know how to get and modify the in-development source code of the ROHC library and send your changes for inclusion in the library. ===== Get source code with Bazaar ===== In order to modify the ROHC library, you must first get the in-development source code of the library. This may be achieved by using the Bazaar (bzr) Version Control System (VCS). Bazaar may often be found in the software packages of your distribution. Otherwise, follow the instructions at http://bazaar-vcs.org/Download. You may also want to read the Bazaar User Guide at http://doc.bazaar-vcs.org/latest/en/user-guide/index.html. In any case, you may get help by running 'bzr help' or 'bzr help <command>' at the shell prompt. To get a fresh copy of the source code, type the following:<code> $ bzr branch lp:rohc</code> You should now have a copy of the ROHC repository on your disk in the 'rohc' subdirectory. ===== Build the source code ===== Enter the 'rohc' subdirectory and then follow the instructions to [[library-install-sources#versions_1301|configure and build the library]] starting with step 7. ===== Run the non-regression tests ===== Follow the [[library-tests#versions_140|instructions to run the non-regression tests]]. It is important that there is no regression in the source code before you start modifying the library. ===== Modifying the source code ===== Use your favorite code editor to change the source code of the ROHC library. You may have a look at the [[http://rohc-lib.org/|API documentation]]. You may also read the [[http://lists.launchpad.net/rohc/|questions asked by developers]] on the public mailing list dedicated to the ROHC library or [[http://launchpad.net/~rohc/+join|send new questions by subscribing to the list]]. ===== Building and testing your changes ===== Please build your changes on different environments. Please also test your changes by running the non-regression tests. Adding new tests that check your changes is also a great idea. ===== Submitting your modifications ===== Add all new source or capture files with Bazaar:<code> $ bzr add <new source files> <new captures files></code> Create a patch that contains all your modifications (or several small patches if applicable) with Bazaar:<code> $ bzr diff > /path/to/my/patch</code> Now, send an email to the ROHC mailing list. Please describe carefully your changes and attach your patch. Be careful to not send too large attachments (this could be the case if you added some non-regression tests with PCAP files). Put your files on an HTTP or FTP server and send a link to them to the mailing list.

library-hacking.1342282390.txt.gz · Last modified: 2015/05/25 12:47 (external edit)