| 1 |
####################################################################### |
| 2 |
# # |
| 3 |
# DAPL Patch Guide # |
| 4 |
# # |
| 5 |
# James Lentini # |
| 6 |
# jlentini at users.sourceforge.net # |
| 7 |
# # |
| 8 |
# Created 03/30/2005 # |
| 9 |
# Version 1.0 # |
| 10 |
# # |
| 11 |
####################################################################### |
| 12 |
|
| 13 |
|
| 14 |
Overview |
| 15 |
-------- |
| 16 |
|
| 17 |
The DAPL Reference Implementation (RI) Team welcomes code contributions |
| 18 |
and bug fixes from RI users. This document describes the format for |
| 19 |
submitting patches to the project. |
| 20 |
|
| 21 |
Directions |
| 22 |
---------- |
| 23 |
|
| 24 |
When implementing a new feature or bug fix, please remember to: |
| 25 |
|
| 26 |
+ Use the project coding style, described in doc/dapl_coding_style.txt |
| 27 |
+ Remember that the RI supports multiple platforms and transports. If |
| 28 |
your modification is not applicable to all platforms and transports, |
| 29 |
please ensure that the implement does not affect these other |
| 30 |
configurations. |
| 31 |
|
| 32 |
When creating the patch: |
| 33 |
|
| 34 |
+ Create the patch using a unified diff as follows: |
| 35 |
diff -Naur old-code new-code > patch |
| 36 |
+ Create the patch from the root of the CVS tree. |
| 37 |
|
| 38 |
When submitting the patch: |
| 39 |
|
| 40 |
+ Compose an email message containing a brief description of the patch, |
| 41 |
a signed-off by line, and the patch. |
| 42 |
+ Have the text "[PATCH]" at the start of the subject line |
| 43 |
+ Send the message to [email protected] |
| 44 |
|
| 45 |
Example |
| 46 |
------- |
| 47 |
|
| 48 |
Here is an example patch message: |
| 49 |
|
| 50 |
------------------------------------------------------------ |
| 51 |
Date: 30 Mar 2005 11:49:45 -0500 |
| 52 |
From: Jane Doe |
| 53 |
To: [email protected] |
| 54 |
Subject: [PATCH] fixed status returns |
| 55 |
|
| 56 |
Here's a patch to fix the status return value in |
| 57 |
dats_handle_vector_init(). |
| 58 |
|
| 59 |
Signed-off-by: Jane Doe <jdoe at pseudonyme.com> |
| 60 |
|
| 61 |
--- dat/common/dat_api.c~ 2005-03-30 11:58:40.838968000 -0500 |
| 62 |
+++ dat/common/dat_api.c 2005-03-28 12:33:29.502076000 -0500 |
| 63 |
@@ -70,16 +70,15 @@ |
| 64 |
{ |
| 65 |
DAT_RETURN dat_status; |
| 66 |
int i; |
| 67 |
- int status; |
| 68 |
|
| 69 |
dat_status = DAT_SUCCESS; |
| 70 |
|
| 71 |
g_hv.handle_max = DAT_HANDLE_ENTRY_STEP; |
| 72 |
|
| 73 |
- status = dat_os_lock_init (&g_hv.handle_lock); |
| 74 |
- if ( DAT_SUCCESS != status ) |
| 75 |
+ dat_status = dat_os_lock_init (&g_hv.handle_lock); |
| 76 |
+ if ( DAT_SUCCESS != dat_status ) |
| 77 |
{ |
| 78 |
- return status; |
| 79 |
+ return dat_status; |
| 80 |
} |
| 81 |
|
| 82 |
g_hv.handle_array = dat_os_alloc (sizeof(void *) * DAT_HANDLE_ENTRY_STEP); |
| 83 |
------------------------------------------------------------ |