HACKING
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:10k
源码类别:

Symbian

开发平台:

C/C++

  1. How to write code for CVS
  2. * Source
  3. Patches against the development version of CVS are most likely to be accepted:
  4. $ cvs -d:pserver:anoncvs@cvs.cvshome.org/cvsroot co ccvs
  5. * Compiler options
  6. If you are using GCC, you'll want to configure with -Wall, which can
  7. detect many programming errors.  This is not the default because it
  8. might cause spurious warnings, but at least on some machines, there
  9. should be no spurious warnings.  For example:
  10. $ CFLAGS="-g -Wall" ./configure
  11. Configure is not very good at remembering this setting; it will get
  12. wiped out whenever you do a ./config.status --recheck, so you'll need
  13. to use:
  14. $ CFLAGS="-g -Wall" ./config.status --recheck
  15. * Indentation style
  16. CVS mostly uses a consistent indentation style which looks like this:
  17. void
  18. foo (arg)
  19.     char *arg;
  20. {
  21.     if (arg != NULL)
  22.     {
  23. bar (arg);
  24. baz (arg);
  25.     }
  26.     switch (c)
  27.     {
  28. case 'A':
  29.     aflag = 1;
  30.     break;
  31.     }
  32. }
  33. The file cvs-format.el contains settings for emacs and the NEWS file
  34. contains a set of options for the indent program which I haven't tried
  35. but which are correct as far as I know.  You will find some code which
  36. does not conform to this indentation style; the plan is to reindent it
  37. as those sections of the code are changed (one function at a time,
  38. perhaps).
  39. In a submitted patch it is acceptable to refrain from changing the
  40. indentation of large blocks of code to minimize the size of the patch;
  41. the person checking in such a patch should reindent it.
  42. * Portability
  43. The general rule for portability is that it is only worth including
  44. portability cruft for systems on which people are actually testing and
  45. using new CVS releases.  Without testing, CVS will fail to be portable
  46. for any number of unanticipated reasons.
  47. The current consequence of that general rule seems to be that if it
  48. is in ANSI C and it is in SunOS4 (using /bin/cc), generally it is OK
  49. to use it without ifdefs (for example, assert() and void * as long as
  50. you add more casts to and from void * than ANSI requires.  But not
  51. function prototypes).  Such constructs are generally portable enough,
  52. including to NT, OS/2, VMS, etc.
  53. * Run-time behaviors
  54. Use assert() to check "can't happen" conditions internal to CVS.  We
  55. realize that there are functions in CVS which instead return NULL or
  56. some such value (thus confusing the meaning of such a returned value),
  57. but we want to fix that code.  Of course, bad input data, a corrupt
  58. repository, bad options, etc., should always print a real error
  59. message instead.
  60. Do not use arbitrary limits (such as PATH_MAX) except perhaps when the
  61. operating system or some external interface requires it.  We spent a
  62. lot of time getting rid of them, and we don't want to put them back.
  63. If you find any that we missed, please report it as with other bugs.
  64. In most cases such code will create security holes (for example, for
  65. anonymous readonly access via the CVS protocol, or if a WWW cgi script
  66. passes client-supplied arguments to CVS).
  67. Although this is a long-term goal, it also would be nice to move CVS
  68. in the direction of reentrancy.  This reduces the size of the data
  69. segment and will allow a multi-threaded server if that is desirable.
  70. It is also useful to write the code so that it can be easily be made
  71. reentrant later.  For example, if you need to pass data from a
  72. Parse_Info caller to its callproc, you need a static variable.  But
  73. use a single pointer so that when Parse_Info is fixed to pass along a
  74. void * argument, then the code can easily use that argument.
  75. * Coding standards in general
  76. Generally speaking the GNU coding standards are mostly used by CVS
  77. (but see the exceptions mentioned above, such as indentation style,
  78. and perhaps an exception or two we haven't mentioned).  This is the
  79. file standards.text at the GNU FTP sites.
  80. Filenames for .c and .h files may contain _ but should not contain -
  81. (the latter causes Visual C++ 2.1 to create makefiles which Visual C++
  82. 4.0 cannot use).
  83. * Regenerating Build Files
  84. On UNIX, if you wish to change the Build files, you will need Autoconf and
  85. Automake.
  86. Some combinations of Automake and Autoconf versions may break the
  87. CVS build if file timestamps aren't set correctly and people don't
  88. have the same versions the developers do, so the rules to run them
  89. automatically aren't included in the generated Makefiles unless you run
  90. configure with the --enable-maintainer-mode option.
  91. The CVS Makefiles and configure script were built using Automake 1.7.9 and
  92. Autoconf 2.58, respectively.
  93. There is a known bug in Autoconf 2.57 that will prevent the configure
  94. scripts it generates from working on some platforms.  Other combinations of
  95. autotool versions may or may not work.  If you get other versions to work,
  96. please send a report to <bug-cvs@gnu.org>.
  97. * Writing patches (strategy)
  98. Only some kinds of changes are suitable for inclusion in the
  99. "official" CVS.  Bugfixes, where CVS's behavior contradicts the
  100. documentation and/or expectations that everyone agrees on, should be
  101. OK (strategically).  For features, the desirable attributes are that
  102. the need is clear and that they fit nicely into the architecture of
  103. CVS.  Is it worth the cost (in terms of complexity or any other
  104. tradeoffs involved)?  Are there better solutions?
  105. If the design is not yet clear (which is true of most features), then
  106. the design is likely to benefit from more work and community input.
  107. Make a list of issues, or write documentation including rationales for
  108. how one would use the feature.  Discuss it with coworkers, a
  109. newsgroup, or a mailing list, and see what other people think.
  110. Distribute some experimental patches and see what people think.  The
  111. intention is arrive at some kind of rough community consensus before
  112. changing the "official" CVS.  Features like zlib, encryption, and
  113. the RCS library have benefitted from this process in the past.
  114. If longstanding CVS behavior, that people may be relying on, is
  115. clearly deficient, it can be changed, but only slowly and carefully.
  116. For example, the global -q option was introduced in CVS 1.3 but the
  117. command -q options, which the global -q replaced, were not removed
  118. until CVS 1.6.
  119. * Writing patches (tactics)
  120. When you first distribute a patch it may be suitable to just put forth
  121. a rough patch, or even just an idea.  But before the end of the
  122. process the following should exist:
  123.   - ChangeLog entry (see the GNU coding standards for details).
  124.   - Changes to the NEWS file and cvs.texinfo, if the change is a
  125.     user-visible change worth mentioning.
  126.   - Somewhere, a description of what the patch fixes (often in
  127.     comments in the code, or maybe the ChangeLog or documentation).
  128.   - Most of the time, a test case (see TESTS).  It can be quite
  129.     frustrating to fix a bug only to see it reappear later, and adding
  130.     the case to the testsuite, where feasible, solves this and other
  131.     problems.  See the TESTS file for notes on writing new tests.
  132. If you solve several unrelated problems, it is generally easier to
  133. consider the desirability of the changes if there is a separate patch
  134. for each issue.  Use context diffs or unidiffs for patches.
  135. Include words like "I grant permission to distribute this patch under
  136. the terms of the GNU Public License" with your patch.  By sending a
  137. patch to bug-cvs@gnu.org, you implicitly grant this permission.
  138. Submitting a patch to bug-cvs is the way to reach the people who have
  139. signed up to receive such submissions (including CVS developers), but
  140. there may or may not be much (or any) response.  If you want to pursue
  141. the matter further, you are probably best off working with the larger
  142. CVS community.  Distribute your patch as widely as desired (mailing
  143. lists, newsgroups, web sites, whatever).  Write a web page or other
  144. information describing what the patch is for.  It is neither practical
  145. nor desirable for all/most contributions to be distributed through the
  146. "official" (whatever that means) mechanisms of CVS releases and CVS
  147. developers.  Now, the "official" mechanisms do try to incorporate
  148. those patches which seem most suitable for widespread usage, together
  149. with test cases and documentation.  So if a patch becomes sufficiently
  150. popular in the CVS community, it is likely that one of the CVS
  151. developers will eventually try to do something with it.  But dealing
  152. with the CVS developers may be the last step of the process rather
  153. than the first.
  154. * What is the schedule for the next release?
  155. There isn't one.  That is, upcoming releases are not announced (or
  156. even hinted at, really) until the feature freeze which is
  157. approximately 2 weeks before the final release (at this time test
  158. releases start appearing and are announced on info-cvs).  This is
  159. intentional, to avoid a last minute rush to get new features in.
  160. * Mailing lists
  161. Anyone can add themselves to the following mailing lists:
  162.     dev.  Unless you are accepted as a CVS developer as
  163.       described in the DEVEL-CVS file, you will only be able to
  164.       read this list, not send to it.  The charter of the list is
  165.       also in DEVEL-CVS.
  166.     cvs.  The only messages sent to this list are sent
  167.       automatically, via the CVS `loginfo' mechanism, when someone
  168.       checks something in to the master CVS repository.
  169.     test-results.  The only messages sent to this list are sent
  170.       automatically, daily, by a script which runs "make check"
  171.       and "make remotecheck" on the master CVS sources.
  172. To subscribe to dev, cvs, or test-results, send
  173. a message to "<list>-subscribe@ccvs.cvshome.org" or visit
  174. http://ccvs.cvshome.org/servlets/ProjectMailingListList and follow the
  175. instructions there.
  176. One other list related to CVS development is bug-cvs.  This is the
  177. list which users are requested to send bug reports to.  Anyone can
  178. subscribe; to do so send mail to bug-cvs-request@gnu.org.
  179. Other CVS discussions take place on the info-cvs mailing list
  180. (send mail to info-cvs-request@gnu.org to subscribe) or on
  181. the newsgroup comp.software.config-mgmt.