Specification code submission log

1 Submit a suggestion

  • Before submitting the code, update (svn up), compile, and the function test is normal.
  • To maintain atomic submissions, it is recommended to submit a function or a bug once, and it is not recommended to submit multiple functions or bugs at once, nor is it recommended to submit a function or bug multiple times.
  • The order of commands to submit code: svn up, (svn add), svn diff, svn commit –m / -F.
  • Submit code with clear remarks. You can refer to the log format in Chapter 3.
  • It is recommended that after the submission code is completed, use another set of code to update the previous submission, and compile and test.
  • To facilitate the preparation of the submission log when submitting svn code, you can refer to the following two methods:

method 1:

#cd /home/xxxxx(user name)

#vi ~/.subversion/config

#Modify or add editor-cmd = vi

Note:

After setting, submit the code without adding -m parameter, it will automatically open vi. After writing the comment, save and exit vi (wq), the code is automatically submitted.

If you give up this commit halfway, you can forcefully quit vi (! Q), and the svn commit is terminated.

Method 2:

svn commit --editor-cmd=vi file1.txt fil2.txt

2 Log format

<type> <module>: <summary> 
// Empty line 
Description: Description of the 
    problem. 
    the phenomenon , lower case is recommended, especially the first character. 
Reason: 
    The root cause of the problem. 
    the reason 
Solution: 
    the solution to the problem. 
    the solution 
Code Review: 
    A list of people who help check the code. If no code review is performed, it should be marked as "no review". 
    RD1 , RD2, RD3, … / no review 
Test Result: 
    The test situation of the problem, pass the test, pass the test, not tested, you need to indicate the reason for not testing. 
    pass / no test for environment

2.1 Type and summary description

type represents the type of a certain submission, such as whether to fix a bug (problem) or add a feature (function). The summary is a brief description of a submission, and the type value can only be the value listed in the following table. All type types and corresponding summary content are as follows.

type

commend

summary

fix

Fix bug

The bug number is like alpha bug 56; if there is no number, briefly explain the source of the bug, such as who was discovered by RD XXX

feature

new features

If you refer to other project groups, you can indicate the group name and project name; also indicate the source of the demand

porting

Synchronize the codes of different products in the same project group

Porting project name and version number

append

Additional submission, used when the last submission is missing

The last submission has a missing version number

patch

Synchronize three parties such as econet's patch

Indicate the source of the patch

revert

Roll back to the previous version

The version number of the previous version

compile

Problems related to project building tools and compilation

To be added

refactor

Code refactoring, no new features or bug fixes

To be added

perf

Optimization related, such as improving performance, experience, etc.

To be added

style

Only modified spaces, format indentation, etc. without changing the code logic

To be added

docs

Only modified the document

To be added

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

2.2 module description

module represents the type of module involved in this submission. Multiple modules are separated by commas. The module name can only be listed in the following table, please pay attention to capitalization. In addition, if you find that the list is missing, please submit. All current modules are listed below.

No

Name

Note

No

Name

Note

No

Name

Note

1

busybox

 

3

webserver

 

5

samba

 

2

dhcp

 

4

webpage

 

6

dlna

 

.

  

.

 

.

  

Guess you like

Origin www.cnblogs.com/aimmiao/p/12760849.html