Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 59 lines (44 sloc) 2.48 kB
4bc042b initial public release v1.50
Patrick Titiano authored
1 ###############################################################################
2 # #
3 # How to submit OMAPCONF changes #
4 # #
5 ###############################################################################
6
7
8 Please try to follow the guidelines below. This will make things
9 easier on the maintainers. Not all of these guidelines matter for every
10 trivial patch so apply some common sense.
11
12 1. Always ###TEST### your changes, however small.
13 Run provided OMAPCONF non-regression test suites.
14
15 2. Make sure your changes compile correctly (0 warning, 0 error).
16 OMAPCONF follows same coding convention as Linux Kernel.
17 PLEASE check your patch with the Linux Kernel automated style checker
18 (scripts/checkpatch.pl) to catch trival style violations.
19 See Linux Kernel "Documentation/CodingStyle" for guidance.
20
21 3. All functions in *.c source files should use the following
22 doxygen-compliant function header:
23
24 /* ------------------------------------------------------------------------*//**
25 * @FUNCTION function name (only name, not full prototype)
26 * @BRIEF short description of the function role.
27 * @RETURNS returned value(s)
28 * @param[in] for unchanged argument(s)
29 * @param[in, out] for modified argument(s)
30 * @DESCRIPTION complete description of the function role.
31 *//*------------------------------------------------------------------------ */
32
33 All created files shall come with he following
34 doxygen-compliant file header:
35
36 /* ======================================================================= *//**
37 * @Component OMAPCONF
38 * @Filename name of the file
39 * @Description main purpose of the functions in this file
40 * @Author author
41 * @Date year of creation
42 * @Copyright person or company owning this code
43 *//*======================================================================== */
44
45 Please keep the same spacing (with tabs) between tags and descriptions
46
47 4. Make patch available to omapconf_contribution@list.ti.com
48
49 PLEASE document known bugs. If it doesn't work for everything
50 or does something very odd once a month document it.
51
52 PLEASE remember that submissions should include a Signed-off-by: line.
53
54 5. Make sure you have the right to send any changes you make. If you
55 do changes at work you may find your employer owns the patch
56 not you.
57
58 Thanks!
Something went wrong with that request. Please try again.