apply tizen coding style
[platform/core/api/common.git] / README
1 --------------------------------------------------------------
2 How to update error messages
3 --------------------------------------------------------------
4 1. Copy common/tool/error_msg_template.xml to common/error_messages/{your_package_name}.xml.
5 2. Modify "package uri" in the xml file, which means git path of your package.
6 3. Add you error enumerators into the xml file. 
7    If your enumerator has same value as enumerator in tizen_error_e, then you don't have to add that error enumerator. (Ex. APP_ERROR_NONE, APP_ERROR_INVALID_PARAMETER)
8     - error name : The name of error enumerator
9     - value : The value of error enumerator. This value MUST be represented by error macro in tizen.h
10         ex) TIZEN_ERROR_APPLICATION | 0x01 (O)
11             CAMERA_ERROR_CLASS | 0x02 (X) => CAMERA_ERROR_CLASS is defined in camera.h. This MUST be "TIZEN_ERROR_CAMERA | 0x02".
12     - msg : The message of error enumerator
13 4. If you pushed changes into gerrit, then please add the following people as reviewer.
14   - Sunggyu Choi (sunggyu.choi@samsung.com)
15   - Minseok Jang (m.s.jang@samsung.com)
16   - ByungWoo Lee (bw1212.lee@samsung.com)
17
18
19
20 --------------------------------------------------------------
21 How to submit this package with updated error messages
22 --------------------------------------------------------------
23 1. Run python common/tool/update_msg_header.sh
24 2. common/include/private/tizen_error_private.h will be modified, so check "err_list" in that file.
25 3. Submit this package by "gbs submit".