Difference between revisions of "TSK Developer's Guide"

From SleuthKitWiki
Jump to: navigation, search
(Initial version created.)
 
(Moved some content from here to the Developer Guidelines page.)
Line 1: Line 1:
This page contains information on developing code for TSK, Autopsy, and related tools. If you are looking for a guide that helps to incorporate the TSK library into your tools, then refer to the [[Library User's Guide]].  
+
This page contains technical information on developing code for TSK, Autopsy, and related tools. If you are looking for a guide that helps to incorporate the TSK library into your tools, then refer to the [[Library User's Guide]].  
  
 
This page is a work in progress and more information will be posted.  Here are some starting points.  
 
This page is a work in progress and more information will be posted.  Here are some starting points.  
 +
* The [[Developer Guidelines]] define how code and patches can be submitted and incorporated into the distribution.
 
* The [http://lists.sourceforge.net/lists/listinfo/sleuthkit-developers Sleuth Kit Developers] list exists to discuss the development of the tools.  Subscribe to ask and answer questions.  
 
* The [http://lists.sourceforge.net/lists/listinfo/sleuthkit-developers Sleuth Kit Developers] list exists to discuss the development of the tools.  Subscribe to ask and answer questions.  
 
* If you want to contribute documentation, then refer to the [http://www.sleuthkit.org/support.php Support] page.  
 
* If you want to contribute documentation, then refer to the [http://www.sleuthkit.org/support.php Support] page.  
  
  
= Submitting Code / Patches =
+
= Technical Details =
To contribute code or patches to the project, send e-mail to the [http://lists.sourceforge.net/lists/listinfo/sleuthkit-developers sleuthkit-developers] list. Include the new code or diffs of the changes. Code submissions should follow the TSK error handling, Unicode, and other conventions. To make the changes as portable as possible, use generic methods and libraries and avoid ones that are platform-specific. A more detailed list of guidelines is being developed.
+
 
+
To make diffs of the changes, run the following command on a Unix system (or from cygwin on Windows):
+
 
+
<code>
+
% diff -Nru sleuthkit-old sleuthkit-new > changes.patch
+
</code>
+
 
+
The patches and code contributions will be reviewed and incorporated into the main development if they are approved. It is also helpful to submit test images and test cases that can be used to test the new code.
+
 
+
= Guidelines =
+
 
To be defined...
 
To be defined...

Revision as of 09:37, 14 September 2008

This page contains technical information on developing code for TSK, Autopsy, and related tools. If you are looking for a guide that helps to incorporate the TSK library into your tools, then refer to the Library User's Guide.

This page is a work in progress and more information will be posted. Here are some starting points.

  • The Developer Guidelines define how code and patches can be submitted and incorporated into the distribution.
  • The Sleuth Kit Developers list exists to discuss the development of the tools. Subscribe to ask and answer questions.
  • If you want to contribute documentation, then refer to the Support page.


Technical Details

To be defined...